README.md in config_yml-0.0.4 vs README.md in config_yml-0.0.5

- old
+ new

@@ -1,14 +1,14 @@ -config.yml +config_yml ========== Simplify your app configuration. Description ----------- -config.yml provides a very simple way of configure your ruby applications through yaml files. +config_yml provides a very simple way of configure your ruby applications through yaml files. Installation ------------ If you are using Bundler, add the following code to your Gemfile: @@ -33,12 +33,12 @@ ```ruby require "configuration" ``` -Examples --------- +Usage +----- ```yaml # config/redis.yml password: foo host: localhost @@ -110,9 +110,26 @@ - :blue ``` ```ruby Configuration.matryoshka[:foo][:bar][:baz] # => { :array => [:red, :green, :blue] } +``` + +Manage yaml files +----------------- + +Avoid maintain .yml files in your repository since they very ofter cointain sensitive information. You can use .yml.sample or .yml.example file instead with fake data. + +To transform sample files in yaml files, you can use the following task: + +```console +$ rake config_yml:generate +``` + +If you are not using Rails, first add this to your Rakefile: + +```ruby +require "configuration/tasks" ``` License -------