You are here

Home » API reference » TinyPNG 7

README.txt in TinyPNG 7

Same filename and directory in other branches
  1. 8 README.txt
CONTENTS OF THIS FILE
---------------------
    
 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Maintainers
  
 
INTRODUCTION
------------
Provides TinyPNG integration for Drupal 7. This module creates a new
ImageToolkit which uses other toolkits in the background. The secondary toolkit
could be the core GD or ImageMagick toolkit provided by ImageMagick module.

In the background TinyPNG module just calls the functions of secondary toolkit
but in the last step it sends the image to the TinyPNG API to compress it.
 
What does TinyPNG do?
TinyPNG uses smart lossy compression techniques to reduce the file size of your
PNG 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 can
still be large. Use TinyPNG to shrink images for your apps and sites. It will
use less bandwidth and load faster.

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


REQUIREMENS
------------
Libraries module

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

Tinify PHP library >= 1.3.0
You can download it from https://github.com/tinify/tinify-php/

 
INSTALLATION
------------
Download Tinify PHP library v1.3.0+ from https://github.com/tinify/tinify-php/
and place it under $DRUPAL_ROOT/sites/all/libraries

You can also install Tinify PHP with drush: just run drush tinypng-library.

After Tinify PHP library installation the Tinfiy.php should be found
at $DRUPAL_ROOT/sites/all/libraries/tinify-php/lib/Tinify.php

Install as you would normally install a contributed Drupal module.
See: https://drupal.org/documentation/install/modules-themes/modules-7
for further information.

INSTALLATION VIA DRUSH
----------------------
A Drush command is provided for easy installation of the Tinify-PHP library.

drush tinypng-library
The command will download the library and unpack it in "sites/all/libraries".
 
CONFIGURATION
------------
Having installed the module, go to admin/config/media/image-toolkit page and
select TinyPNG as default Image toolkit.
Save the form. Then select the secondary toolkit.
Save the form. Then setup the secondary toolkit too.


MAINTAINERS
------------
Vince Tikász, https://www.drupal.org/u/tikaszvince
István Csáki, https://www.drupal.org/u/csakiistvan

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3.     

  4.  * Introduction

  5.  * Requirements

  6.  * Installation

  7.  * Configuration

  8.  * Maintainers

  9.   

  10.  

  11. INTRODUCTION

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

  13. Provides TinyPNG integration for Drupal 7. This module creates a new

  14. ImageToolkit which uses other toolkits in the background. The secondary toolkit

  15. could be the core GD or ImageMagick toolkit provided by ImageMagick module.

  16. 

  17. In the background TinyPNG module just calls the functions of secondary toolkit

  18. but in the last step it sends the image to the TinyPNG API to compress it.

  19.  

  20. What does TinyPNG do?

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

  22. PNG files. By selectively decreasing the number of colors in the image, fewer

  23. bytes are required to store the data. The effect is nearly invisible but it

  24. makes a very large difference in file size!

  25. 

  26. Why should I use TinyPNG?

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

  28. partially transparent images. The format uses compression, but the files can

  29. still be large. Use TinyPNG to shrink images for your apps and sites. It will

  30. use less bandwidth and load faster.

  31. 

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

  33. 

  34. 

  35. REQUIREMENS

  36. ------------

  37. Libraries module

  38. 

  39. A TinyPNG API key

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

  41. 

  42. Tinify PHP library >= 1.3.0

  43. You can download it from https://github.com/tinify/tinify-php/

  44. 

  45.  

  46. INSTALLATION

  47. ------------

  48. Download Tinify PHP library v1.3.0+ from https://github.com/tinify/tinify-php/

  49. and place it under $DRUPAL_ROOT/sites/all/libraries

  50. 

  51. You can also install Tinify PHP with drush: just run drush tinypng-library.

  52. 

  53. After Tinify PHP library installation the Tinfiy.php should be found

  54. at $DRUPAL_ROOT/sites/all/libraries/tinify-php/lib/Tinify.php

  55. 

  56. Install as you would normally install a contributed Drupal module.

  57. See: https://drupal.org/documentation/install/modules-themes/modules-7

  58. for further information.

  59. 

  60. INSTALLATION VIA DRUSH

  61. ----------------------

  62. A Drush command is provided for easy installation of the Tinify-PHP library.

  63. 

  64. drush tinypng-library

  65. The command will download the library and unpack it in "sites/all/libraries".

  66.  

  67. CONFIGURATION

  68. ------------

  69. Having installed the module, go to admin/config/media/image-toolkit page and

  70. select TinyPNG as default Image toolkit.

  71. Save the form. Then select the secondary toolkit.

  72. Save the form. Then setup the secondary toolkit too.

  73. 

  74. 

  75. MAINTAINERS

  76. ------------

  77. Vince Tikász, https://www.drupal.org/u/tikaszvince

  78. István Csáki, https://www.drupal.org/u/csakiistvan