Skip to content
Browse files

improve readme

  • Loading branch information...
1 parent 60b6a97 commit e4e0dcae5b9ad9e38dbd6e26496509d4ddbc9a97 @cjc committed May 17, 2011
Showing with 14 additions and 2 deletions.
  1. +14 −2 readme.md
View
16 readme.md
@@ -2,7 +2,19 @@
Littering is an [ender](https://github.com/ender-js/ender) based variation of [Lettering.js](https://github.com/davatron5000/Lettering.js). Where lettering.js injects positional classes for styling chars/words/lins, Littering accepts functions to determine which classes to apply to which elements.
-##Lettering.js compliance
+##See it
+
+Check the examples at [http://cjc.github.com/littering]()
+
+##Use it
+
+Get littering by including it in your ender build
+
+```
+ender add littering
+```
+
+###Lettering.js compliant behaviour
Littering mimics the same api as Lettering.js for the base functionality of decorating chars/words/lines with their position.
@@ -14,7 +26,7 @@ $("#demo4 h1").littering('words').children("span").littering();
$("#demo5 h1").littering().children("span").css({'display':'inline-block', '-webkit-transform':'rotate(-25deg)'});
```
-##Other uses
+###Other functionality
In addition to simply numbering elements, littering accepts custom formatter functions to allow arbitrary substitution of elements and complex class setting.

0 comments on commit e4e0dca

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