-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dd50ddb
commit 75d276a
Showing
1 changed file
with
23 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,53 @@ | ||
# thumbor-plugins | ||
[![Github Actions - tests](https://github.com/thumbor/thumbor-plugins/actions/workflows/test.yml/badge.svg)](https://github.com/thumbor/thumbor-plugins/actions) | ||
|
||
This monorepo contains multiple plugins that should be used on [Thumbor](https://github.com/thumbor/thumbor) to add new capabilities, like GifV or Mozjpeg compression. | ||
This monorepo contains multiple plugins that should be used on | ||
[Thumbor][thumbor] to add new capabilities, like GifV or Mozjpeg compression. | ||
|
||
Each of the optimizers is released and can be installed separately. | ||
|
||
## 📜 List of thumbor-plugins | ||
|
||
You can find the plugins in: https://pypi.org/search/?q=%22thumbor-plugins%22&o=-created | ||
|
||
## ⚙️ Installation | ||
``` | ||
|
||
```bash | ||
pip install thumbor-plugins-mozjpeg | ||
pip install thumbor-plugins-gifv | ||
``` | ||
|
||
## 🎯 Usage | ||
after installing the packages, | ||
just add the plugins you need to the OPTIMIZERS list on your thumbor.conf | ||
``` | ||
|
||
After installing the packages, just add the plugins you need to the OPTIMIZERS | ||
list on your thumbor.conf | ||
|
||
```python | ||
OPTIMIZERS = [ | ||
'thumbor_plugins.optimizers.mozjpeg', | ||
'thumbor_plugins.optimizers.gifv', | ||
] | ||
``` | ||
|
||
Each optimizer contains parameters that can be used to configure how it runs. | ||
|
||
## 👍 Contribute | ||
|
||
thumbor-plugins is an open-source project with many contributors. Join them | ||
[contributing code](https://github.com/thumbor/thumbor-plugins/blob/master/CONTRIBUTING.md). | ||
[contributing code][contributing]. | ||
|
||
|
||
## 🚨 Breaking change | ||
This repository used to be released under a single package in previous versions, `thumbor-plugins` | ||
|
||
We broke down into multiple packages to make it easier for developers to contribute, test, and use different versions. | ||
This repository used to be released under a single package in previous | ||
versions, `thumbor-plugins`. | ||
|
||
We broke down into multiple packages to make it easier for developers to | ||
contribute, test, and use different versions. | ||
|
||
For example, the mozjpeg optimizer is released on the package `thumbor-plugins-mozjpeg`, and the Gifv one on the package `thumbor-plugins-gifv` | ||
For example, the mozjpeg optimizer is released on the package | ||
`thumbor-plugins-mozjpeg`, and the Gifv one on the package | ||
`thumbor-plugins-gifv`. | ||
|
||
[contributing]: https://github.com/thumbor/thumbor-plugins/blob/master/CONTRIBUTING.md | ||
[thumbor]: https://github.com/thumbor/thumbor |