summaryrefslogtreecommitdiffstats
path: root/README.rdoc
diff options
context:
space:
mode:
authorJérémy Zurcher <jeremy@asynk.ch>2012-01-04 11:01:31 +0100
committerJérémy Zurcher <jeremy@asynk.ch>2012-01-04 11:01:31 +0100
commit84bd3b23734b4df2b4f643e45cdc50e16e2c02bb (patch)
tree6519c7257d4b8074ac73e3b1070e0dcd3c04c55c /README.rdoc
parentb0a20bab875e1310ca1726d267569eebb7e12c81 (diff)
downloadzorglub-84bd3b23734b4df2b4f643e45cdc50e16e2c02bb.zip
zorglub-84bd3b23734b4df2b4f643e45cdc50e16e2c02bb.tar.gz
update top level files
Diffstat (limited to 'README.rdoc')
-rw-r--r--README.rdoc42
1 files changed, 33 insertions, 9 deletions
diff --git a/README.rdoc b/README.rdoc
index bdeaafc..48d08cf 100644
--- a/README.rdoc
+++ b/README.rdoc
@@ -1,21 +1,28 @@
zorglub
- by Jéérmy Zurcher
+ by Jérémy Zurcher
http://cgit.asynk.ch/cgi-bin/cgit/zorglub
== DESCRIPTION:
-a very very light and tiny web application framework based on rack[http://rack.rubyforge.org/]
+a nano web application framework based on rack[http://rack.rubyforge.org/]
-== FEATURES/PROBLEMS:
+== FEATURES:
-* FIXME
+* class#method mapping scheme (/class_mapping/method_name/*args)
+* class level layout and engine specification
+* method level layout, engine and view specification
+* before_all and after_all methods callbacks
+* redirection
+* partial
+* class level inherited variables
+* session
== SYNOPSIS:
-* FIXME
-
-For less minimalistic and more sane examples you may look at:
+For a simple test application run:
+* rackup ./example/sample.ru
+Don't forget to look at
* the spec/ folder
== REQUIREMENTS:
@@ -24,13 +31,30 @@ For less minimalistic and more sane examples you may look at:
== DOWNLOAD/INSTALL:
-* FIXME
+From rubygems:
+
+ [sudo] gem install zorglub
+
+or from the git repository on github:
+
+ git clone git://github.com/jeremyz/zorglub.git
+ cd zorglub
+ rake gem:install
+
+== RESOURCES:
+
+You can find this project in a few places:
+
+Online repositories:
+
+* https://github.com/jeremyz/zorglub
+* http://cgit.asynk.ch/cgi-bin/cgit/zorglub/
== CREDITS:
Special thanks to:
-* FIXME
+* Manveru [https://github.com/manveru/innate]
== LICENSE: