diff --git a/README.md b/README.md new file mode 100644 index 0000000..523c27d --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +[![Build Status](https://secure.travis-ci.org/JonRowe/Catwalk.png)](http://travis-ci.org/JonRowe/Catwalk) +# Catwalk + +Presenter gem library. See features for use. + +## Installation + +Add this line to your application's Gemfile: + + gem 'catwalk' + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install catwalk + +## Usage + +See features. + +## 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