You are here

Home » API reference » TinyPNG 8

README.txt in TinyPNG 8

Same filename and directory in other branches
  1. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * TODO


INTRODUCTION
------------
This module provides TinyPNG integration for Drupal 8.

What does TinyPNG do?
TinyPNG uses smart lossy compression techniques to reduce the file size of your
PNG or JPG files. By selectively decreasing the number of colors in the image,
fewer bytes are required to store the data. The effect is nearly invisible but
it makes a very large difference in file size!

Why should I use TinyPNG?
PNG is useful because it's the only widely supported format that can store
partially transparent images. The format uses compression, but the files still
can be large. Use TinyPNG to shrink images for your apps and sites. They will
use less bandwidth and load faster.

For more information about TinyPNG please visit https://tinypng.com/.


REQUIREMENS
------------
A TinyPNG API key
You can request one for free at https://tinypng.com/developers.

Tinify PHP library >= 1.4.0


INSTALLATION
------------
1. Go to your site root directory and run
  "composer require tinify/tinify:1.4.*".
2. Enable TinyPNG in the Drupal admin.


CONFIGURATION
------------
Having installed the module, go to /admin/config/tinypng page and set your
TinyPNG API key.

On the same page you can select the mode you want to compress images.

With "Compress on upload" mode you will compress images when they are uploaded.

With "TinyPNG image action" mode you have the opportunity to keep your original
image untouched and select the image styles you want to compress.
When this mode is enabled you can add TinyPNG effect to any of your
image styles.



TODO
------------
* Make the file size displayed after upload the compressed image size rather
  than the original. After refreshing the page the filesize is correctly
  displayed.
* Create a service to provide this module's functionality for other modules to
  integrate.
* Implement ImageMagick toolkit operation

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * TODO

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. This module provides TinyPNG integration for Drupal 8.

  14. 

  15. What does TinyPNG do?

  16. TinyPNG uses smart lossy compression techniques to reduce the file size of your

  17. PNG or JPG files. By selectively decreasing the number of colors in the image,

  18. fewer bytes are required to store the data. The effect is nearly invisible but

  19. it makes a very large difference in file size!

  20. 

  21. Why should I use TinyPNG?

  22. PNG is useful because it's the only widely supported format that can store

  23. partially transparent images. The format uses compression, but the files still

  24. can be large. Use TinyPNG to shrink images for your apps and sites. They will

  25. use less bandwidth and load faster.

  26. 

  27. For more information about TinyPNG please visit https://tinypng.com/.

  28. 

  29. 

  30. REQUIREMENS

  31. ------------

  32. A TinyPNG API key

  33. You can request one for free at https://tinypng.com/developers.

  34. 

  35. Tinify PHP library >= 1.4.0

  36. 

  37. 

  38. INSTALLATION

  39. ------------

  40. 1. Go to your site root directory and run

  41.   "composer require tinify/tinify:1.4.*".

  42. 2. Enable TinyPNG in the Drupal admin.

  43. 

  44. 

  45. CONFIGURATION

  46. ------------

  47. Having installed the module, go to /admin/config/tinypng page and set your

  48. TinyPNG API key.

  49. 

  50. On the same page you can select the mode you want to compress images.

  51. 

  52. With "Compress on upload" mode you will compress images when they are uploaded.

  53. 

  54. With "TinyPNG image action" mode you have the opportunity to keep your original

  55. image untouched and select the image styles you want to compress.

  56. When this mode is enabled you can add TinyPNG effect to any of your

  57. image styles.

  58. 

  59. 

  60. 

  61. TODO

  62. ------------

  63. * Make the file size displayed after upload the compressed image size rather

  64.   than the original. After refreshing the page the filesize is correctly

  65.   displayed.

  66. * Create a service to provide this module's functionality for other modules to

  67.   integrate.

  68. * Implement ImageMagick toolkit operation