Permalink
Browse files

Change README to include info about the gem.

  • Loading branch information...
1 parent 123e444 commit d4976c805a1f3b86929afe0b6792ddbdbd68b373 @clayallsopp committed May 23, 2012
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
View
@@ -12,6 +12,24 @@ A UIViewController->URL router.
Why is this awesome? Because now you can push any view controller from any part of the app with just a string: buttons, push notifications, anything.
+## Installation
+
+```ruby
+gem install routable
+```
+
+And now in your Rakefile, require `routable`:
+
+```ruby
+$:.unshift("/Library/RubyMotion/lib")
+require 'motion/project'
+require 'routable'
+
+Motion::Project::App.setup do |app|
+ ...
+end
+```
+
## Setup
For every UIViewController you want routable with `:symbolic` params, you need to define `.initWithParams({})`.

0 comments on commit d4976c8

Please sign in to comment.