Add more README sections.
This commit is contained in:
parent
8216c91e88
commit
798932046a
1 changed files with 31 additions and 0 deletions
31
README.md
31
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
|
||||
|
|
Loading…
Reference in a new issue