Skip to content

Commit

Permalink
Update README.rdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ddollar committed Sep 28, 2012
1 parent 0426292 commit 015a384
Showing 1 changed file with 1 addition and 33 deletions.
34 changes: 1 addition & 33 deletions README.rdoc
@@ -1,33 +1 @@
= rack-maintenance = This project is now maintained at https://github.com/tilsammans/rack-maintenance

Rack::Maintenance is a simple Rack middleware to detect the existence of a
maintenance.html page and display that instead of incoming requests.

== Installation

sudo gem install rack-maintenance

== Usage

# config/environment.rb
config.middleware.use 'Rack::Maintenance',
:file => Rails.root.join('public', 'maintenance.html'),
:env => 'MAINTENANCE'

If <tt>:env</tt> is specified, all requests will be shown the
maintenance page if the environment variable is set.

If <tt>:env</tt> is not specified, the maintenance page will be shown if it exists.

== Note on Patches/Pull Requests

* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with Rakefile or VERSION (do that in a separate commit if you want a local version)
* Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2009 David Dollar. See LICENSE for details.

0 comments on commit 015a384

Please sign in to comment.