diff --git a/README.md b/README.md index 98db3d2..59728ec 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,12 @@ Image conversion on the fly using PHP ===================================== -The `CImage.php` is a class that can resize and crop images and output them to -a webpage. The class preserves a cache of the generated images and responds with -HTTP 304 if the image has not changed. +About +------------------------------------- + +The `CImage.php` is a PHP class that can resize and crop images on the fly and output +them to, for example to a webpage. The class preserves a cache of the generated images +and responds with HTTP 304 (not modified) if the image has not changed. The file `img.php` uses `CImage.php` to resize images. It is a usecase on how to use the class. `img.php` is useful for webpages which want to dynamically resize the images. @@ -11,34 +14,58 @@ the class. `img.php` is useful for webpages which want to dynamically resize the The file `test.php` has testcases that show the results of `img.php` with different settings. -The file `example.php` makes an example on how to use and integrate `img.php` with your -website and shows why this might be a handy tool for content providers. +Start by reviewing the `test.php`, then have a look at `img.php` and finally go through +`CImage.php`. -Start by reading the `example.php`, proceed by reviewing the `test.php`, then have a look -at `img.php` and finally go through `CImage.php`. +CImage lives at github: https://github.com/mosbth/cimage Enjoy! Mikael Roos (mos@dbwebb.se) +Installation +------------------------------------- + +1. Clone from github: git://github.com/mosbth/cimage.git + +2. Make the cache directory writable by the webserver. + +
+ chmod 777 cache +
+ +3. Point your browser to `test.php`. + +4. Advanced usage. Put `img.php` in your `/img`-directory. Create a `.htaccess` in your +web root folder containing the following line: + +
+ RewriteEngine on + RewriteRule ^image/(.*)$ img/img.php?src=$1 [QSA,NC,L] +
+ +Now you can access and resize your images through `/image/someimage.jpg?w=80`. Very handy. + + Revision history ----------------- +------------------------------------- ToDo. -* Pre-defined sizes. +* Improved support for pre-defined sizes. * crop-to-fit, add parameter for offset x and y to enable to define which area is the center of the image from which the crop is done. -* Show how to integrate with WordPress. +* Show how to integrate with WordPress, shortcodes. +* Support for resizing opaque images. -v0.3 (2012-08-28) +v0.3 (2012-10-02) * Added crop. Can crop a area (`width`, `height`, `start_x`, `start_y`) from the original image. * Corrected to make the 304 Not Modified header work. -* Added `example.php`to walk through a real live example on how to use `img.php` in a -website. +* Pre-defined sizes can be configured for width in `img.php`. +* Corrected to make crop work with width or height in combination with crop-to-fit. v0.2 (2012-05-09)