README.md in sinatra-contrib-1.3.2 vs README.md in sinatra-contrib-1.4.0
- old
+ new
@@ -1,20 +1,15 @@
+[](http://travis-ci.org/sinatra/sinatra-contrib)
+
Collection of common Sinatra extensions, semi-officially supported.
# Goals
* For every future Sinatra release, have at least one fully compatible release
* High code quality, high test coverage
* Include plugins people usually ask for a lot
-# TODO
-
-* Write documentation, integrate into Sinatra website
-* Finish imports and rewrites
-* Wrap up first release
-* Find contributors (both code and docs)
-
# Included extensions
## Common Extensions
These are common extension which will not add significant overhead or change any
@@ -44,11 +39,11 @@
* `sinatra/multi_route`: Adds ability to define one route block for multiple
routes and multiple or custom HTTP verbs.
* `sinatra/namespace`: Adds namespace support to Sinatra.
-* `sinatra/respond_with`: Choose action and/or template depending automatically
+* `sinatra/respond_with`: Choose action and/or template automatically
depending on the incoming request. Adds helpers `respond_to` and
`respond_with`.
## Custom Extensions
@@ -67,9 +62,15 @@
* `sinatra/extension`: Mixin for writing your own Sinatra extensions.
* `sinatra/test_helpers`: Helper methods to ease testing your Sinatra
application. Partly extracted from Sinatra. Testing framework agnostic
+
+# Installation
+Add `gem 'sinatra-contrib'` to *Gemfile*, then execute `bundle install`.
+
+If you don't use Bundler, install the gem manually by executing `gem install sinatra-contrib` in your command line.
+
# Usage
## Classic Style