Skip to content
Browse files

updating readme

  • Loading branch information...
1 parent 280cf1f commit 506abdbeb223d2b6afeb9f549e0d53fbfa200cac @aberant committed
Showing with 7 additions and 9 deletions.
  1. +7 −9 README.rdoc
View
16 README.rdoc
@@ -15,6 +15,10 @@ It takes your PNG's, chews them up and spits out sprites!
point bin/css-spriter at a directory, and watch it sprite away!
+CSS-Spriter uses Chunky PNG for it's PNG manipulation. Not only is it super fast, but the library is a great example of fast, efficient ruby programming.
+
+Chunky PNG is written in pure ruby, this means you can sprite up anything using MRI, JRuby, or Rubinius.
+
== Installation - standalone
sudo gem install css-spriter
@@ -35,7 +39,7 @@ For a full list of options:
=== Usage - Rails plugin
-Spittle assumes all of your sprites are located in the directory public/images/sprites. This directory should contain sub-directories for each sprite you wish to create. The css class names for an image in a sprite will take the form <directory_name>_<image_name>. Here is an example:
+CSS-Spriter assumes all of your sprites are located in the directory public/images/sprites. This directory should contain sub-directories for each sprite you wish to create. The css class names for an image in a sprite will take the form <directory_name>_<image_name>. Here is an example:
sprites /
cars /
@@ -45,14 +49,10 @@ Spittle assumes all of your sprites are located in the directory public/images/s
boeing.png
cesna.png
-Running sprite:generate does all the work. Each sprite directory (cars, planes) will now contain a sprite.png. Spittle will also generate a sprites.css stylesheet in public/stylesheets/ that you should include in your layout. If you wished to use the ford image from the cars sprite you would give the 'cars_ford' class to the desired element in the view. That's it!
-
-Check out examples/sprites if you want to see what spriter can do without doing any work.
+Running the sprite:generate task does all the work. Each sprite directory (cars, planes) will now contain a sprite.png. Spittle will also generate a sprites.css stylesheet in public/stylesheets/ that you should include in your layout. If you wished to use the ford image from the cars sprite you would give the 'cars_ford' class to the desired element in the view. That's it!
-== Limitations
+Check out examples/sprites if you want to see what CSS-Spriter can do without doing any work.
-- does not support color profiles (can cause a slight change in color from the source image)
-- does not support reading interlaced PNGs.
== Features
@@ -62,12 +62,10 @@ Check out examples/sprites if you want to see what spriter can do without doing
- Rails plugin & rake tasks (sprite:generate & sprite:cleanup)
- Supports varying dimensions in source images
- Does not regenerate sprites that have not changed
-- Supports all PNG filter types to improve image compression
- supports mixing RGB and RGBA color types
== Roadmap - by priority
-- Reading interlaced images
- allow a global css template override
- allow per-sprite and global configuration

0 comments on commit 506abdb

Please sign in to comment.
Something went wrong with that request. Please try again.