From 798932046a4947bdb9d98339c5606ea995099c40 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Tue, 14 Jul 2015 23:05:08 +0200 Subject: [PATCH] Add more README sections. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index f962b1b..4f878ba 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,34 @@ in one single command. * Tmuxinator (the same goal, based on tmux instead of Konsole) +# Kook + +TODO: Write a gem description + +## Installation + +Add this line to your application's Gemfile: + +```ruby +gem 'kook' +``` + +And then execute: + + $ bundle + +Or install it yourself as: + + $ gem install kook + +## Usage + +TODO: Write usage instructions here + +## Contributing + +1. Fork it ( https://github.com/[my-github-username]/kook/fork ) +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request