-
Notifications
You must be signed in to change notification settings - Fork 3
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
09c31ee
commit 027a639
Showing
1 changed file
with
7 additions
and
5 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,4 +1,4 @@ | ||
| # README | ||
| # Fork CMS Compression Module | ||
|
|
||
| ## Description | ||
| The Fork CMS Compression module let's you compress PNG & JPG images on your website. Use this module to shrink images on your site so they will use **less bandwidth and your website will load faster**. The compression module uses the free API of [TinyPNG](https://tinypng.com/) and [TinyJPG](https://tinyjpg.com/). | ||
|
|
@@ -17,21 +17,23 @@ I did the test with 3 images (3264x2448 resolution) taken from my camera. I uplo | |
|
|
||
| 1. Upload the `/src/Backend/Modules/Compression` folder to your `/src/Backend/Modules` folder. | ||
| 3. Browse to your Fork CMS backend. | ||
| 4. Go to `Settings > Modules`. Click on the install button next to the menu module. | ||
| 4. Go to `Settings > Modules`. Click on the install button next to the Comprossion module in the uninstalled list. | ||
| 5. Go to `Settings > Modules > Compression` to use it. | ||
| 6. Have fun! | ||
|
|
||
| ## How to use it | ||
|
|
||
| 1. Get a free API key (500 images/month) [here](https://tinypng.com/developers) | ||
| 1. Get a free API key (500 images/month for free) [here](https://tinypng.com/developers) | ||
| 2. Go to `Settings > Modules > Compression` and enter your API key | ||
| 3. Choose a few folders containing images to compress | ||
| 3. In the tree structure, choose a few folders with images to compress. Press save. Then press the execute button to start compression. | ||
| 4. Use a cronjob if you want to compress these images once in a while, or press the execute button to compress the images on the fly. | ||
|
|
||
| Note: We store a history of compressed files in the database with a checksum. By doing that, we can ignore files that already have been compressed and ignore them when a new compression task starts. | ||
|
|
||
| ## Bugs | ||
|
|
||
| If you encounter any bugs, please create an issue and I'll try to fix it (or feel free to fix it yourself with a pull-request). | ||
|
|
||
| ## Discussion | ||
| - Slack: [Fork CMS Slack channel](https://fork-cms.herokuapp.com) | ||
| - Twitter: [@jessedobbelaere](https://www.twitter.com/jessedobbelaere) | ||
| - E-mail: <[email protected]> for any questions or remarks. | ||