diff --git a/README.md b/README.md index 10f33a8..0c2b169 100644 --- a/README.md +++ b/README.md @@ -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: -: - description: - required: - forbidden: - initial_value: + : + description: + required: + forbidden: + initial_value: ### 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)