README.md in rocketio-0.0.0 vs README.md in rocketio-0.0.1
- old
+ new
@@ -1,9 +1,26 @@
-# Rocketio
+# RocketIO
-TODO: Write a gem description
+#### Simple, Fast, Scalable Micro-Web-Framework for Ruby
+Sample controller:
+
+```ruby
+class Users < RocketIO::Controller
+
+ # serving GET requests
+ def get
+ end
+
+ # serving POST requests
+ def post
+ end
+
+ # same for other request methods
+end
+```
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -16,16 +33,16 @@
Or install it yourself as:
$ gem install rocketio
-## Usage
+## Controllers
-TODO: Write usage instructions here
+
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/rocketio/fork )
+1. Fork it ( https://github.com/sleewoo/rocketio/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request