borekon/img-optimize
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Changelog and Readme

Browse Source
This commit is contained in:
VirtuBox 2020-11-11 12:56:44 +01:00
parent f445537361
commit e91fee0836
No known key found for this signature in database
GPG Key ID: 22EB296C97BAD476
3 changed files with 145 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
CHANGELOG.md
View File

@ -14,6 +14,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
- option --no-run-if-empty added to xargs - option --no-run-if-empty added to xargs
- scripts to compile optipng & libwebp from source - scripts to compile optipng & libwebp from source
- Avif (AV1 Image Format) support - Avif (AV1 Image Format) support
- Avoid optimizing the same image at the same moment [PR #12](https://github.com/VirtuBox/img-optimize/pull/12)
### Changed ### Changed

17
README.md
View File

@ -81,18 +81,23 @@ Bash script to optimize your images and convert them in WebP
Usage: img-optimize [options] <images path> Usage: img-optimize [options] <images path>
If images path isn't defined, img-optimize will use the current directory If images path isn't defined, img-optimize will use the current directory
Options: Options:
--jpg <images path> ..... optimize all jpg images --jpg ..... optimize all jpg images
--png <images path> ..... optimize all png images --png ..... optimize all png images
--webp <images path> ..... convert all images in webp --webp ..... convert all images in webp
--nowebp <images path> ..... optimize all png & jpg images --avif ..... convert all images in avif
--all <images path> ..... optimize all images (png + jpg + webp) --std ..... optimize all png & jpg images
--next ..... convert all images in webp & avif
--all ..... optimize all images (png + jpg + webp + avif)
-i, --interactive ..... run img-optimize in interactive mode -i, --interactive ..... run img-optimize in interactive mode
-q, --quiet ..... run image optimization quietly -q, --quiet ..... run image optimization quietly
--path <images path> ..... define images path
Other options : Other options :
-h, --help, help ... displays this help information -h, --help, help ... displays this help information
--cmin [+|-]<n> ... File's status was last changed n minutes ago.
act find cmin argument (+n : greater than n, -n : less than n, n : exactly n)
Examples: Examples:
optimize all jpg images in /var/www/images optimize all jpg images in /var/www/images
img-optimize --jpg /var/www/images img-optimize --jpg --path /var/www/images
``` ```
### Update the script ### Update the script

31
docs/README.md
View File

@ -2,13 +2,14 @@
![img-optimize](https://raw.githubusercontent.com/VirtuBox/img-optimize/master/img-optimize.png) ![img-optimize](https://raw.githubusercontent.com/VirtuBox/img-optimize/master/img-optimize.png)
[![Travis](https://img.shields.io/travis/virtubox/img-optimize.svg)](https://travis-ci.org/VirtuBox/img-optimize) ![GitHub](https://img.shields.io/github/license/VirtuBox/img-optimize.svg) ![GitHub release](https://img.shields.io/github/release/VirtuBox/img-optimize.svg) ![GitHub last commit](https://img.shields.io/github/last-commit/VirtuBox/img-optimize.svg) ![Github stars](https://img.shields.io/github/stars/VirtuBox/img-optimize.svg) [![Travis](https://travis-ci.org/VirtuBox/img-optimize.svg?branch=master)](https://travis-ci.org/VirtuBox/img-optimize) ![GitHub](https://img.shields.io/github/license/VirtuBox/img-optimize.svg) ![GitHub release](https://img.shields.io/github/release/VirtuBox/img-optimize.svg) ![GitHub last commit](https://img.shields.io/github/last-commit/VirtuBox/img-optimize.svg) ![Github stars](https://img.shields.io/github/stars/VirtuBox/img-optimize.svg)
## Prerequisite ## Prerequisite
- jpegoptim for jpg optimization - jpegoptim for jpg optimization
- optipng for png optimization - optipng for png optimization
- cwebp for WebP conversion - cwebp for WebP conversion
- go-avif for Avif conversion
### From APT repositories ### From APT repositories
@ -36,6 +37,13 @@ curl -sL git.io/fjddn | sudo -E bash
curl -sL git.io/fjdd6 | sudo -E bash curl -sL git.io/fjdd6 | sudo -E bash
``` ```
### Go-Avif installation
```bash
sudo wget -qO /usr/local/bin/avif https://github.com/Kagami/go-avif/releases/download/v0.1.0/avif-linux-x64
sudo chmod +x /usr/local/bin/avif
```
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
## Installation ## Installation
@ -73,21 +81,26 @@ Bash script to optimize your images and convert them in WebP
Usage: img-optimize [options] <images path> Usage: img-optimize [options] <images path>
If images path isn't defined, img-optimize will use the current directory If images path isn't defined, img-optimize will use the current directory
Options: Options:
--jpg <images path> ..... optimize all jpg images --jpg ..... optimize all jpg images
--png <images path> ..... optimize all png images --png ..... optimize all png images
--webp <images path> ..... convert all images in webp --webp ..... convert all images in webp
--nowebp <images path> ..... optimize all png & jpg images --avif ..... convert all images in avif
--all <images path> ..... optimize all images (png + jpg + webp) --std ..... optimize all png & jpg images
--next ..... convert all images in webp & avif
--all ..... optimize all images (png + jpg + webp + avif)
-i, --interactive ..... run img-optimize in interactive mode -i, --interactive ..... run img-optimize in interactive mode
-q, --quiet ..... run image optimization quietly -q, --quiet ..... run image optimization quietly
--path <images path> ..... define images path
Other options : Other options :
-h, --help, help ... displays this help information -h, --help, help ... displays this help information
--cmin [+|-]<n> ... File's status was last changed n minutes ago.
act find cmin argument (+n : greater than n, -n : less than n, n : exactly n)
Examples: Examples:
optimize all jpg images in /var/www/images optimize all jpg images in /var/www/images
img-optimize --jpg /var/www/images img-optimize --jpg --path /var/www/images
``` ```
## Update the script ### Update the script
To update the script, just run : To update the script, just run :
@ -95,7 +108,7 @@ To update the script, just run :
git -C $HOME/.img-optimize pull git -C $HOME/.img-optimize pull
``` ```
## Setup daily cronjob ### Setup daily cronjob
You just have to copy the scripts to /etc/cron.daily : You just have to copy the scripts to /etc/cron.daily :