README.md in cupcakinator-0.0.2 vs README.md in cupcakinator-0.0.4

- old
+ new

@@ -1,9 +1,39 @@ -# Cupcakinator +# cupcakinator [![Build Status](https://travis-ci.org/rubyisbeautiful/cupcakinator.png)](https://travis-ci.org/rubyisbeautiful/cupcakinator) -TODO: Write a gem description +## Description +cupcakinator provides a simple way to use the 'config' pattern in any class. For example, given class Foo: + + class Foo + include Cupcakinator + + cupcakinate + end + +and the file ./config/config.yml: + + --- + bacon: + flavor: pork + meatball: + flavor: + - pork + - chicken +You can do: + + >> Foo.config.bacon.flavor + 'pork' + >> Foo.config.meatball.flavor + ['pork','chicken'] + >> Foo.new.config.bacon.flavor + 'pork' + +etc.. +Options include dir, file, and method. + + ## Installation Add this line to your application's Gemfile: gem 'cupcakinator' @@ -16,10 +46,11 @@ $ gem install cupcakinator ## Usage -TODO: Write usage instructions here +include Cupcakinator +call 'cupcakinator' in your class with dir, file, and method options ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)