Skip to content

Commit

Permalink
Merge pull request #4 from rousisk/patch-1
Browse files Browse the repository at this point in the history
Provide some installation instructions in readme
  • Loading branch information
techiferous committed Jun 30, 2015
2 parents 19d73fb + 8f8f763 commit 9e614e4
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ Never again will you accidentally delete production data! Rack::Environmental a
an indicator badge to your web application so that you can tell whether you're
working with the staging, test, development or production version of your web app.

== Installation

For bundler-managed applications just include Rack::Environmental in your Gemfile:

gem 'rack-environmental'

Alternatively, you can install Rack::Environmental manually:

$ gem install rack-environmental

== Usage

This Rack middleware can be used with any Rack application, but here's how you would
Expand Down Expand Up @@ -48,4 +58,4 @@ Here's the full list of configuration options:
If there's a context where you want Rack::Environmental to specifically ignore your
requests, such as a Jasmine test runner which returns essentially empty files to be
built on by the test runner, you can "shut off" Rack::Environmental for that context
by adding `:style => :none` to its options.
by adding `:style => :none` to its options.

0 comments on commit 9e614e4

Please sign in to comment.