Skip to content

Commit 699bed3

Browse files
committed
Merge branch 'readme'
2 parents c39d6bc + 29c9ada commit 699bed3

File tree

1 file changed

+41
-29
lines changed

1 file changed

+41
-29
lines changed

README.md

+41-29
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# typisttech/image-optimize-command
22

3-
[![Packagist](https://img.shields.io/packagist/v/typisttech/image-optimize-command.svg)](https://packagist.org/packages/typisttech/image-optimize-command)
4-
[![Packagist](https://img.shields.io/packagist/dt/typisttech/image-optimize-command.svg)](https://packagist.org/packages/typisttech/image-optimize-command)
3+
[![Packagist](https://img.shields.io/packagist/v/typisttech/image-optimize-command.svg?style=flat-square)](https://packagist.org/packages/typisttech/image-optimize-command)
4+
[![Packagist](https://img.shields.io/packagist/dt/typisttech/image-optimize-command.svg?style=flat-square)](https://packagist.org/packages/typisttech/image-optimize-command)
5+
![PHP from Packagist](https://img.shields.io/packagist/php-v/TypistTech/image-optimize-command?style=flat-square)
56
[![CircleCI](https://circleci.com/gh/TypistTech/image-optimize-command.svg?style=svg)](https://circleci.com/gh/TypistTech/image-optimize-command)
67
[![codecov](https://codecov.io/gh/TypistTech/image-optimize-command/branch/master/graph/badge.svg)](https://codecov.io/gh/TypistTech/image-optimize-command)
7-
[![GitHub](https://img.shields.io/github/license/TypistTech/image-optimize-command.svg)](https://github.com/TypistTech/image-optimize-command/blob/master/LICENSE.md)
8-
[![GitHub Sponsor](https://img.shields.io/badge/Sponsor-GitHub-ea4aaa)](https://github.com/sponsors/TangRufus)
9-
[![Sponsor via PayPal](https://img.shields.io/badge/Sponsor-PayPal-blue.svg)](https://typist.tech/donate/image-optimize-command/)
10-
[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-ff69b4.svg)](https://typist.tech/contact/)
8+
[![GitHub](https://img.shields.io/github/license/TypistTech/image-optimize-command.svg?style=flat-square)](https://github.com/TypistTech/image-optimize-command/blob/master/LICENSE.md)
9+
[![GitHub Sponsor](https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?style=flat-square&logo=github)](https://github.com/sponsors/TangRufus)
10+
[![Sponsor via PayPal](https://img.shields.io/badge/Sponsor-PayPal-blue.svg?style=flat-square&logo=paypal)](https://typist.tech/donate/image-optimize-command/)
11+
[![Hire Typist Tech](https://img.shields.io/badge/Hire-Typist%20Tech-ff69b4.svg?style=flat-square)](https://typist.tech/contact/)
12+
[![Twitter Follow @TangRufus](https://img.shields.io/twitter/follow/TangRufus?style=flat-square&color=1da1f2&logo=twitter)](https://twitter.com/tangrufus)
1113

1214
Easily optimize images using WP CLI.
1315

@@ -16,7 +18,8 @@ Easily optimize images using WP CLI.
1618

1719

1820
- [Usage](#usage)
19-
- [Installing](#installing)
21+
- [Requirements](#requirements)
22+
- [Installation](#installation)
2023
- [Optimization tools](#optimization-tools)
2124
- [SVGO and cwebp are optional](#svgo-and-cwebp-are-optional)
2225
- [Use Cases](#use-cases)
@@ -35,10 +38,10 @@ Easily optimize images using WP CLI.
3538
- [Do I have to install `SVGO` or `cwebp`?](#do-i-have-to-install-svgo-or-cwebp)
3639
- [`PHP Fatal error: Allowed memory size of 999999 bytes exhausted (tried to allocate 99 bytes)`](#php-fatal-error-allowed-memory-size-of-999999-bytes-exhausted-tried-to-allocate-99-bytes)
3740
- [Does it have a limits or quotas?](#does-it-have-a-limits-or-quotas)
38-
- [Will you add support for older PHP versions?](#will-you-add-support-for-older-php-versions)
3941
- [Is it for everyone?](#is-it-for-everyone)
42+
- [Will you add support for older PHP versions?](#will-you-add-support-for-older-php-versions)
4043
- [It looks awesome. Where can I find some more goodies like this?](#it-looks-awesome-where-can-i-find-some-more-goodies-like-this)
41-
- [This package isn't on wp.org. Where can I give a :star::star::star::star::star: review?](#this-package-isnt-on-wporg-where-can-i-give-a-starstarstarstarstar-review)
44+
- [Where can I give :star::star::star::star::star: reviews?](#where-can-i-give-starstarstarstarstar-reviews)
4245
- [Sponsoring :heart:](#sponsoring-heart)
4346
- [GitHub Sponsors Matching Fund](#github-sponsors-matching-fund)
4447
- [Why don't you hire me?](#why-dont-you-hire-me)
@@ -87,11 +90,14 @@ $ wp help image-optimize
8790
$ wp help image-optimize <subcommand>
8891
```
8992

90-
## Installing
93+
## Requirements
9194

92-
Installing this package requires [WP-CLI v2.3.0](https://wp-cli.org/) or greater. Update to the latest stable release with `wp cli update`.
95+
- PHP v7.2 or later
96+
- [WP-CLI](https://wp-cli.org/) v2.3.0 or greater
9397

94-
Once you've done so, you can install this package with:
98+
Since [`wp-cli/wp-cli-bundle` bundles an older version of `symfony/process`](https://github.com/wp-cli/wp-cli-bundle/blob/7e3d89c415db7922e923703d5f06613f0a60b8a9/composer.lock#L1204-L1205) which incompatible with [`spatie/image-optimizer`](https://github.com/spatie/image-optimizer/blob/48f71b968f2764eca8f4885a8a5401d61e920ba8/composer.json#L22), WP-CLI must be [installed via composer](https://make.wordpress.org/cli/handbook/installing/#installing-via-composer).
99+
100+
## Installation
95101

96102
```bash
97103
$ wp package install typisttech/image-optimize-command:@stable
@@ -283,36 +289,42 @@ This is a common WP CLI issue. See: [https://bit.ly/wpclimem](https://make.wordp
283289

284290
No, unlike other SaaS alternatives, this package runs on your server without any limitation on file sizes or a monthly quota. Totally free of charge.
285291

286-
### Will you add support for older PHP versions?
287-
288-
Never! This package will only works on [actively supported PHP versions](https://secure.php.net/supported-versions.php).
289-
290-
Don't use it on **end of life** or **security fixes only** PHP versions.
291-
292292
### Is it for everyone?
293293

294294
No, it comes at a cost. Optimization is CPU intensive. Expect CPU usage rockets up to 100% during optimization. Schedule it to run at late night in small batches.
295295

296296
Learn more on [this article](https://typist.tech/articles/easily-optimize-wordpress-images-using-wp-cli-and-some-binaries/).
297297

298+
### Will you add support for older PHP versions?
299+
300+
Never! This plugin will only work on [actively supported PHP versions](https://secure.php.net/supported-versions.php).
301+
302+
Don't use it on **end of life** or **security fixes only** PHP versions.
303+
298304
### It looks awesome. Where can I find some more goodies like this?
299305

300-
* Articles on Typist Tech's [blog](https://typist.tech)
301-
* [Tang Rufus' WordPress plugins](https://profiles.wordpress.org/tangrufus#content-plugins) on wp.org
302-
* More projects on [Typist Tech's GitHub profile](https://github.com/TypistTech)
303-
* Stay tuned on [Typist Tech's newsletter](https://typist.tech/go/newsletter)
304-
* Follow [Tang Rufus' Twitter account](https://twitter.com/TangRufus)
305-
* Hire [Tang Rufus](https://typist.tech/contact) to build your next awesome site
306+
- Articles on Typist Tech's [blog](https://typist.tech)
307+
- More projects on [Typist Tech's GitHub profile](https://github.com/TypistTech/)
308+
- More plugins on [TangRufus'](https://profiles.wordpress.org/tangrufus/#content-plugins) wp.org profiles
309+
- Stay tuned on [Typist Tech's newsletter](https://typist.tech/go/newsletter)
310+
- Follow [@TangRufus](https://twitter.com/tangrufus) on Twitter
311+
- Hire [Tang Rufus](https://typist.tech/contact) to build your next awesome site
306312

307-
### This package isn't on wp.org. Where can I give a :star::star::star::star::star: review?
313+
### Where can I give :star::star::star::star::star: reviews?
308314

309-
Thanks!
315+
Thanks! Glad you like it. It's important to let my know somebody is using this project. Since this is not hosted on wordpress.org, please consider:
310316

311-
Consider writing a blog post, submitting pull requests, [sponsoring](https://typist.tech/donation/) or [hiring me](https://typist.tech/contact/) instead.
317+
- tweet something good with mentioning [@TangRufus](https://twitter.com/tangrufus)
318+
- :star: star this [Github repo](https://github.com/typisttech/image-optimize-command)
319+
- :eyes: [watch](https://github.com/typisttech/image-optimize-command/subscription) this Github repo
320+
- write blog posts
321+
- submit [pull requests](https://github.com/typisttech/image-optimize-command)
322+
- [sponsor](https://github.com/sponsors/TangRufus) Tang Rufus to maintain his open source projects
323+
- hire [Tang Rufus](https://typist.tech/contact) to build your next awesome site
312324

313325
## Sponsoring :heart:
314326

315-
Love `image-optimize-command`? Help me maintain it, a [sponsorship here](https://typist.tech/donation/) can help with it.
327+
Love `WP Contained Hook`? Help me maintain it, a [sponsorship here](https://typist.tech/donation/) can help with it.
316328

317329
### GitHub Sponsors Matching Fund
318330

@@ -345,7 +357,7 @@ Please submit an [issue](https://github.com/TypistTech/image-optimize-command/is
345357

346358
## Change log
347359

348-
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
360+
Please see [CHANGELOG](./CHANGELOG.md) for more information on what has changed recently.
349361

350362
## Security
351363

0 commit comments

Comments
 (0)