README.md in confrider-0.0.1 vs README.md in confrider-0.0.2

@@ -1,9 +1,45 @@
 # Confrider
 
-TODO: Write a gem description
+Configuration managment system with i18n like syntax
 
+## Usage
+
+### little helper(to render yaml files with ERB)
+
+    require "erb"
+    require "yaml"
+    def load_yml(yml_path)
+      YAML.load(ERB.new(File.read(yml_path)).result(binding))
+    end
+
+### settings.yml (example)
+
+    app:
+      name: some app name
+      version: <%= File.read('VERSION') %>
+      subnamespace:
+        another_key: value
+
+### using Confrider
+
+    $cfg = Confrider.from_hash(load_yml('/path/to/settings.yml'))
+    # or short form
+    $cfg = Confrider(load_yml('/path/to/settings.yml'))
+    $cfg['app.name'] # => 'some app name'
+    $cfg['app.version'] # will be rendered through ERB
+    $cfg['app.subnamespace'] # => {'another_key' => 'value'}
+    $cfg['app.subnamespace.another_key'] # => 'value'
+    $cfg['non.existent.key'] # => nil
+    $cfg['non.existent.key', 'default'] # => 'default'
+
+### deep merge hashes
+
+    # load additional hash that will be deeply merged
+    $cfg.from_hash(load_yml('/path/to/settings_local.yml'))
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
     gem 'confrider'
@@ -14,16 +50,13 @@
 
 Or install it yourself as:
 
     $ gem install confrider
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+