https://github.com/wintercms/wn-tinypng-plugin

Winter CMS plugin to automatically optimize images with TinyPNG
https://github.com/wintercms/wn-tinypng-plugin

hacktoberfest

Last synced: about 2 months ago
JSON representation

Winter CMS plugin to automatically optimize images with TinyPNG

• Host: GitHub
• URL: https://github.com/wintercms/wn-tinypng-plugin
• Owner: wintercms
• License: mit
• Created: 2020-08-15T07:10:03.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-08T09:59:42.000Z (9 months ago)
• Last Synced: 2024-04-14T04:55:38.901Z (5 months ago)
• Topics: hacktoberfest
• Language: PHP
• Homepage:
• Size: 11.7 KB
• Stars: 9
• Watchers: 5
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-wintercms - Winter.TinyPNG - TinyPNG integration with the built-in ImageResizer. (Uncategorized / Uncategorized)

README

        
# About

Automatically optimizes resized images with TinyPNG.

# Configuration

If you are using the [`.env` file](https://wintercms.com/docs/setup/configuration#dotenv-configuration) for configuration, simply add your [TinyPNG API Key](https://tinypng.com/dashboard/api) 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](https://wintercms.com/plugin/winter-tinypng), 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](https://github.com/winter/wn-tinypng-plugin), 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.