winter/wn-tinypng-plugin

Automatically optimize resized images in Winter CMS with TinyPNG

Fund package maintenance!
wintercms
Open Collective

Installs: 15 125

Dependents: 0

Suggesters: 0

Security: 0

Stars: 9

Watchers: 5

Forks: 3

Type:winter-plugin

v2.0.0 2021-03-21 04:34 UTC

This package is auto-updated.

Last update: 2024-10-20 03:20:27 UTC


README

Automatically optimizes resized images with TinyPNG.

Configuration

If you are using the .env file for configuration, simply add your TinyPNG API Key to the environment file as TINYPNG_API_KEY. If you are not using the .env file, simply copy plugins/winter/tinypng/config/config.php to config/winter/tinypng/config.php and change the value of apiKey.

That's it! This plugin will then start automatically optimizing images resized with the | resize() filter provided by the Winter CMS core.

NOTE: This plugin will not cause existing resized images to be regenerated. If you would like to regenerate existing images then delete the existing generated images and the resizer will automatically regenerate them for you.

Installation

To install from the Marketplace, click on the "Add to Project" button and then select the project you wish to add it to. Once the plugin has been added to the project, go to the backend and check for updates to pull in the plugin.

To install from the backend, go to Settings -> Updates & Plugins -> Install Plugins and then search for Winter.TinyPNG.

To install from the repository, clone it into plugins/winter/tinypng and then run composer update from your project root in order to pull in the dependencies.

To install it with Composer, run composer require winter/wn-tinypng-plugin from your project root.