Browse files

adding a bit of documentation

  • Loading branch information...
1 parent 7fe6090 commit 09948be740b88248d5dec497f1188ce5ac16b0f6 Jeremy Kelley committed Feb 23, 2011
Showing with 27 additions and 0 deletions.
  1. +27 −0 README.md
View
27 README.md
@@ -0,0 +1,27 @@
+# tornado_addons
+
+Consider this the wicked witch pedaling frantically around Dorothy's house as
+it swirls in the air.... (lame jokes over).
+
+This is a collection of addons and accompanying unit tests for the excellent
+[Tornado web server](http://www.tornadoweb.org/)
+
+These addons are licensed the same as Tornado under the Apache Licence,
+Version 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html).
+
+## Installation
+
+Just place this directory in your python path.
+
+## Testing
+
+Every addon will have a set of accompanying unit tests. We prefer to run them
+via [Nose](http://code.google.com/p/python-nose/).
+
+ cd tornado_addons/
+ nosetests
+
+## Usage
+
+See the comments in (routes.py) or (async_yield.py).
+

0 comments on commit 09948be

Please sign in to comment.