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

- old
+ new

@@ -11,48 +11,99 @@ [travis]: http://travis-ci.org/linyows/octospy [gemnasium]: https://gemnasium.com/linyows/octospy [codeclimate]: https://codeclimate.com/github/linyows/octospy [coveralls]: https://coveralls.io/r/linyows/octospy -Octospy notifies the repository activity to an IRC channel. +Octospy notifies the repository activity to some IRC channels. +<div align="center"> <img src="http://octodex.github.com/images/daftpunktocat-thomas.gif" width="300"> <img src="http://octodex.github.com/images/daftpunktocat-guy.gif" width="300"> +</div> Installation ------------ Add this line to your application's Gemfile: - gem 'octospy' +```ruby +gem 'octospy' +``` And then execute: - $ bundle +```sh +$ bundle +``` Or install it yourself as: - $ gem install octospy +```sh +$ gem install octospy +``` Usage ----- -TODO: Write usage instructions here +```sh +$ cp .emv.example .env +``` +edit `.env`: + +```sh +SERVER=irc.yourserver.net +CHANNELS=yourchannel +GITHUB_LOGIN=yourusername +GITHUB_TOKEN=e17e1c6caa3e452433ab55**************** +``` + +github tokens: https://github.com/settings/applications + +```sh +$ octospy +``` + +### GitHub Enterprise + +add to `.env` + +```sh +GITHUB_API_ENDPOINT=http://your.enterprise.domain/api/v3 +GITHUB_WEB_ENDPOINT=http://your.enterprise.domain +``` + +Commands +-------- + +format: `octospy: <command>` + +Command | Description +------- | ----------- +`watch <repository>` | add repository to watch list (ex: watch rails/rails) +`unwatch <repository>` | remove repository to watch list +`watch <user or organization>` | add user's repositories to watch list (ex: watch dotcloud) +`unwatch <user or organization>` | remove user's repositories to watch list +`job start` | start the repository event monitoring +`job stop` | stop the repository event monitoring +`join <channel>` | invite octospy to another channel +`show watched` | display the watch list +`show status` | display the joined channels + Contributing ------------ 1. Fork it 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 new Pull Request -Author ------- +Authors +------- - [linyows](https://github.com/linyows) License ------- -MIT +The MIT License (MIT)