README.md in envied-0.9.1 vs README.md in envied-0.9.2.rc1

- old
+ new

@@ -1,6 +1,6 @@ -# ENVied [![Build Status](https://travis-ci.org/eval/envied.svg?branch=master)](https://travis-ci.org/eval/envied) +# ENVied [![Build Status](https://travis-ci.org/eval/envied.svg?branch=master)](https://travis-ci.org/eval/envied) [![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://envied-rb.zulipchat.com/) ### TL;DR ensure presence and type of your app's ENV-variables. For the rationale behind this project, see this [blogpost](http://www.gertgoet.com/2014/10/14/envied-or-how-i-stopped-worrying-about-ruby-s-env.html). @@ -17,11 +17,10 @@ * [Configuration](#configuration) * [Types](#types) * [Groups](#groups) * [Defaults](#defaults) * [More examples](#more-examples) -* [Rails](#rails--spring) * [Command-line interface](#command-line-interface) * [How do I...?](#how-do-i) * [Testing](#testing) * [Developing](#developing) * [Contributing](#contributing) @@ -89,15 +88,15 @@ * `:symbol` * `:date` (e.g. '2014-3-26') * `:time` (e.g. '14:00') * `:hash` (e.g. 'a=1&b=2' becomes `{'a' => '1', 'b' => '2'}`) * `:array` (e.g. 'tag1,tag2' becomes `['tag1', 'tag2']`) -* `:uri` (e.g. 'http://www.google.com' becomes `URI.parse('http://www.google.com')` +* `:uri` (e.g. 'http://www.google.com' becomes result of `URI.parse('http://www.google.com')`) ### Groups -Groups give you more flexibility to define when variables are needed. +Groups give you more flexibility to define when variables are needed. It's similar to groups in a Gemfile: ```ruby # file: Envfile variable :FORCE_SSL, :boolean, default: 'false' @@ -145,11 +144,11 @@ variable :FORCE_SSL, :boolean, default: 'false' variable :PORT, :integer, default: proc {|envied| envied.FORCE_SSL ? 443 : 80 } ``` -Please remember that ENVied only **reads** from ENV; it doesn't mutate ENV. +Please remember that ENVied only **reads** from ENV; it doesn't mutate ENV. Don't let setting a default for, say `RAILS_ENV`, give you the impression that `ENV['RAILS_ENV']` is set. As a rule of thumb you should only use defaults: * for local development * for ENV-variables that are solely used by your application (i.e. for `ENV['STAFF_EMAILS']`, not for `ENV['RAILS_ENV']`) @@ -218,10 +217,10 @@ ``` ## Developing ```bash -bundle exec pry --gem +bin/console ``` ## Contributing 1. Fork it: http://github.com/eval/envied/fork