Permalink
Browse files

updated readme so code is properly indented

  • Loading branch information...
1 parent 64ccd2d commit e36f164adff0f6b23c8732e974781d522cb5066c @thinkswan committed Apr 30, 2012
Showing with 30 additions and 30 deletions.
  1. +30 −30 README.md
View
60 README.md
@@ -1,23 +1,23 @@
# app-yml-rails
-This gem provides a Rails application with project-wide settings via an `app.yml` file.
+This gem provides a Rails application with project-wide settings via an **app.yml** file.
## Features
-- Provides project-wide settings via `config/app.yml`
-- Supports `App.settings.nested_settings` syntax
-- Supports all/production/staging/development/test environments (specific environment settings over settings from the 'all' environment)
-- Auto-refreshes `app.yml` changes without requiring an application restart
+- Provides project-wide settings via **config/app.yml**.
+- Supports `App.settings.nested_settings` syntax.
+- Supports **all/production/staging/development/test** environments (specific environment settings over settings from the 'all' environment).
+- Auto-refreshes **app.yml** changes without requiring an application restart.
## Installation
Add the following line to your project's **Gemfile**:
-gem 'app-yml-rails'
+ gem 'app-yml-rails'
Install the config and initializer files:
-$ rails generate app_yml:install
+ $ rails generate app_yml:install
## Usage
@@ -26,38 +26,38 @@ $ rails generate app_yml:install
## Examples
-If **config/app.yml** appears as follows:
+If your **config/app.yml** file appears as follows:
- all:
- emails:
- admin: admin@example.com
- team:
- ceo: ceo@example.com
- max_search_results: 20
- app_name: My Amazing Application
+ all:
+ emails:
+ admin: admin@example.com
+ team:
+ ceo: ceo@example.com
+ max_search_results: 20
+ app_name: My Amazing Application
- development:
- emails:
- team:
- ceo: ceo@localhost
- app_name: My Amazing Application (development)
+ development:
+ emails:
+ team:
+ ceo: ceo@localhost
+ app_name: My Amazing Application (development)
- production:
- app_name: My Amazing Application (production)
+ production:
+ app_name: My Amazing Application (production)
Settings in the **development** environment:
- App.emails.admin => 'admin@example.com'
- App.emails.team.ceo => 'ceo@localhost'
- App.max_search_results => 20
- App.app_name => 'My Amazing Application (development)'
+ App.emails.admin => 'admin@example.com'
+ App.emails.team.ceo => 'ceo@localhost'
+ App.max_search_results => 20
+ App.app_name => 'My Amazing Application (development)'
Settings in the **production** environment:
- App.emails.admin => 'admin@example.com'
- App.emails.team.ceo => 'ceo@example.com'
- App.max_search_results => 20
- App.app_name => 'My Amazing Application (production)'
+ App.emails.admin => 'admin@example.com'
+ App.emails.team.ceo => 'ceo@example.com'
+ App.max_search_results => 20
+ App.app_name => 'My Amazing Application (production)'
## License

0 comments on commit e36f164

Please sign in to comment.