summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorBen Bangert <ben@groovie.org>2012-03-13 11:09:25 -0700
committerBen Bangert <ben@groovie.org>2012-03-13 11:09:25 -0700
commit59d0ec306e2e09d2a2a36c8431ebf9d7517c1931 (patch)
treec268a77f5343be1ac4e506411fe1774377e34336 /README.rst
parent171ecf1168cee5c28cb062d60f2230e6b7c44e19 (diff)
downloadroutes-59d0ec306e2e09d2a2a36c8431ebf9d7517c1931.tar.gz
Various cleanups and such for RTD and travis
--HG-- branch : trunk rename : CHANGELOG => CHANGELOG.rst rename : LICENSE => LICENSE.txt rename : README => README.rst
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..5966ba0
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,22 @@
+Routes 1.11(ish) with:
+* Routes prettyprinter
+* A working, nestable submapper
+* collection(), a more flexible and powerful alternative to resource()
+
+See http://positiveincline.com/?p=550 and http://positiveincline.com/?p=561
+
+--
+
+Routes is a Python re-implementation of the Rails routes system for mapping
+URL's to Controllers/Actions and generating URL's. Routes makes it easy to
+create pretty and concise URL's that are RESTful with little effort.
+
+Speedy and dynamic URL generation means you get a URL with minimal cruft
+(no big dangling query args). Shortcut features like Named Routes cut down
+on repetitive typing.
+
+View the INSTALL for installation instructions. Routes will typically be
+running integrated into an existing framework.
+
+For developers wishing to integrate Routes with their web
+application/framework, consult docs/integration.txt.