use bundler

1 files changed, 56 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..975ca35
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+zorglub
+    by Jérémy Zurcher
+    http://asynk.ch
+
+== DESCRIPTION:
+
+a nano web application framework based on [rack](http://rack.rubyforge.org/)
+
+== FEATURES:
+
+* 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:
+
+For a simple test application run:
+* rackup ./example/sample.ru
+
+Don't forget to look at
+* the spec/ folder
+
+== REQUIREMENTS:
+
+* rack
+
+== DOWNLOAD/INSTALL:
+
+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/
+
+== LICENSE:
+
+[MIT](http://www.opensource.org/licenses/MIT) see [MIT_LICENSE](https://github.com/jeremyz/zorglub/blob/master/MIT-LICENSE)
+