README.md in rack-revision-1.0.1 vs README.md in rack-revision-1.0.2
- old
+ new
@@ -1,44 +1,45 @@
# Rack::Revision
Rack::Revision is a quick drop-in component to enable code revision tracking.
It adds `X-Revision` header with the code revision from capistrano's REVISION file.
+[](https://travis-ci.org/sosedoff/rack-revision)
+
## Installation
-From rubygems:
+Add dependency to your Gemfile:
```
-gem install rack-revision
+gem "rack-revision"
```
-Or install with bundler:
+Install gem:
```
-gem 'rack-revision'
+bundle install
```
-And run `bundle install`
-
## Usage
Rack::Revision is implemented as a piece of Rack middleware and can be used with
any Rack-based application. If you have a `config.ru` rackup file you can
drop the following snippet (for sinatra app):
```ruby
-require 'rack/revision'
+require "rack/revision"
# Basic example
use Rack::Revision
# With custom revision header
-use Rack::Revision, :header => 'X-CODE-VERSION'
+use Rack::Revision, :header => "X-CODE-VERSION"
# With custom filename and default value
-use Rack::Revision, :filename => '.version', :default => 'n/a'
+use Rack::Revision, :filename => ".version", :default => "n/a"
+# Execute application
run Sinatra::Application
```
Available options:
@@ -55,12 +56,23 @@
rake test
```
## License
-Copyright (c) 2012 Dan Sosedoff.
+Copyright (c) 2012-2013 Dan Sosedoff.
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.