README.md in rack-env-0.1.0 vs README.md in rack-env-0.1.1
- old
+ new
@@ -1,16 +1,15 @@
# rack-env
[![Build Status](https://secure.travis-ci.org/banyan/rack-env.png)](http://travis-ci.org/banyan/rack-env)
[<img src="https://gemnasium.com/banyan/rack-env.png" />](https://gemnasium.com/banyan/rack-env)
-Sets .env variables (`ENV['KEY']` pattern).
+Load environment variables from .env or specified file.
Some of the PaaS (such as [Heroku](http://www.heroku.com/) and [Sqale](http://sqale.jp)) are using configuration with .env.
This gem helps you while you are in development mode.
-
## Installation
Add this line to your application's Gemfile:
gem 'rack-env'
@@ -23,44 +22,49 @@
$ gem install rack-env
## Usage
-```
-require 'rack/env'
-```
-
### Rails
```
group :development, :test do
gem 'rack-env'
end
```
-### Rack
+### Rack App (such as sinatra)
```
-# config.ru
-Rack::Builder.new
- use Rack::Env if ENV['RACK_ENV'] == 'development'
- run MyApplication.new
-end
+# app.rb
+require 'rack/env'
+use Rack::Env
```
-* Enable to change .env path like as below.
+* Enable to specified file to load.
```
-# config.ru
-Rack::Builder.new
- use Rack::Env, envfile: 'somewhere/to/.env.development' if ENV['RACK_ENV'] == 'development'
- run MyApplication.new
-end
+# app.rb
+require 'rack/env'
+use Rack::Env, envfile: 'somewhere/to/.env.development'
```
+* Use only local development
+
+```
+# app.rb
+require 'rack/env'
+use Rack::Env if ENV['RACK_ENV'] != 'production'
+```
+
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+
+## Copyright
+
+Copyright (c) 2012 Kohei Hasegawa. See LICENSE for details.