Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KludgeKML committed Nov 20, 2014
1 parent 9cc4042 commit dd51eb5
Showing 1 changed file with 21 additions and 13 deletions.
34 changes: 21 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,31 @@ From RubyGems: [![Gem Version](https://badge.fury.io/rb/unenviable.svg)](http://

In the config/ directory of your rails app, the file unenviable.yml should contain values like these:

GOOGLE_MAPS_ENDPOINT:
description:
required: development, test, staging, production
TEST_DISABLE_HTTPS:
description: Disables the HTTPS section of tests
forbidden: production
initial_value: false
GOOGLE_MAPS_ENDPOINT:
description:
required: development, test, staging, production
TEST_DISABLE_HTTPS:
description: Disables the HTTPS section of tests
forbidden: production
initial_value: false

The structure is:

<ENV VAR NAME>:
description: <description of what the variable is used for>
required: <optional, comma-separated list of environments that need the var to be set>
forbidden: <optional, comma-separated list of environments in which the var must not be set>
initial_value: <optional, initial value to suggest the variable is set to if missing>
<ENV VAR NAME>:
description: <description of what the variable is used for>
required: <optional, comma-separated list of environments that need the var to be set>
forbidden: <optional, comma-separated list of environments in which the var must not be set>
initial_value: <optional, initial value to suggest the variable is set to if missing>

### TOOLS:

unenviable can be called from a post-checkout or merge hook, and will compare the current environment to the one specified in the file.
unenviable can be called from a command line.

$ unenviable check

...can provide a post-checkout or merge hook, comparing the current environment to the one specified in the file.

$ unenviable generate

...will make a .env file with required variables (optional ones will be commented out, descriptions will be included with each variable and initial values will be included)

0 comments on commit dd51eb5

Please sign in to comment.