summaryrefslogtreecommitdiff
path: root/lib/generators/nifty/config/USAGE
diff options
context:
space:
mode:
authorStefan Wintermeyer <stefan.wintermeyer@amooma.de>2012-12-17 12:05:14 +0100
committerStefan Wintermeyer <stefan.wintermeyer@amooma.de>2012-12-17 12:05:14 +0100
commiteaad37485fe59d0306c37cc038dda6d210052910 (patch)
tree072c4b0e33d442528555b82c415f5e7a1712b2b0 /lib/generators/nifty/config/USAGE
parent3e706c2025ecc5523e81ad649639ef2ff75e7bac (diff)
parentb80bd744ad873f6fc43018bc4bfb90677de167bd (diff)
Merge branch 'develop'
Diffstat (limited to 'lib/generators/nifty/config/USAGE')
-rw-r--r--lib/generators/nifty/config/USAGE23
1 files changed, 23 insertions, 0 deletions
diff --git a/lib/generators/nifty/config/USAGE b/lib/generators/nifty/config/USAGE
new file mode 100644
index 0000000..f98972c
--- /dev/null
+++ b/lib/generators/nifty/config/USAGE
@@ -0,0 +1,23 @@
+Description:
+ The nifty_config generator creates YAML file in your config
+ directory and an initializer to load this config. The config has a
+ separate section for each environment. This is a great place to put
+ any config settings you don't want in your app.
+
+ The config is loaded into a constant called APP_CONFIG by default,
+ this changes depending on the name you choose to pass the generator.
+ Use this constant to access the config settings like this.
+
+ APP_CONFIG[:some_setting]
+
+
+Examples:
+ rails generate nifty:config
+
+ Config: config/app_config.yml
+ Initializer: config/initializers/load_app_config.rb
+
+ rails generate nifty:config passwords
+
+ Config: config/passwords_config.yml
+ Initializer: config/initializers/load_passwords_config.rb