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

- old
+ new

@@ -1,31 +1,48 @@ -# Renote +Renote +====== -TODO: Write a gem description +[![Gem Version](http://img.shields.io/gem/v/renote.svg)][gem] +[![Build Status](http://img.shields.io/travis/outrightmental/renote.svg)][travis] +[![Dependency Status](http://img.shields.io/gemnasium/outrightmental/renote.svg)][gemnasium] +[![Code Climate](http://img.shields.io/codeclimate/github/outrightmental/renote.svg)][codeclimate] +[![Coverage Status](http://img.shields.io/coveralls/outrightmental/renote.svg)][coveralls] -## Installation +[gem]: https://rubygems.org/gems/renote +[travis]: http://travis-ci.org/outrightmental/renote +[gemnasium]: https://gemnasium.com/outrightmental/renote +[codeclimate]: https://codeclimate.com/github/outrightmental/renote +[coveralls]: https://coveralls.io/r/outrightmental/renote -Add this line to your application's Gemfile: +Description +----------- +Renote is a CLI for discreet note-taking. Use Renote in order to take notes discreetly. -```ruby -gem 'renote' -``` +Installation +------------ + gem install thor + +## Installation -And then execute: +Install from the command line: - $ bundle - -Or install it yourself as: - $ gem install renote ## Usage -TODO: Write usage instructions here +Because Renote is built on the extraordinarily nifty (Thor)[https://github.com/erikhuda/thor], you can simply run the CLI with no arguments to display the most up-to-date usage information. + $ renote + ## Contributing 1. Fork it ( https://github.com/[my-github-username]/renote/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 + +# Resources + +[A Simple Command Line Tool with Ruby + Thor](http://www.michaelrigart.be/en/blog/a-simple-ruby-command-line-tool.html) + +[Building Your Tools With Thor](http://blog.paracode.com/2012/05/17/building-your-tools-with-thor/) \ No newline at end of file