README.md in sinatra-documentation-0.0.1 vs README.md in sinatra-documentation-0.0.2

- old
+ new

@@ -1,21 +1,26 @@ -# Self +# sinatra-documentation -TODO: Write a gem description +An extension for a Sinatra application that allows your routes to automatically return +help documentation by specifying a route with a '.readme' extension +(ie. '/users/show.readme') and rendering the matched '.md' file. +**NOTE** This is still under development. It works, but will make API changes as it gets +more flushed out. + ## Installation Add this line to your application's Gemfile: - gem 'self' + gem 'sinatra-documentation' And then execute: $ bundle Or install it yourself as: - $ gem install self + $ gem install sinatra-documentation ## Usage TODO: Write usage instructions here