README.md in idonethis-cli-0.12.0 vs README.md in idonethis-cli-0.13.0

- old
+ new

@@ -1,99 +1,99 @@ -A CLI for [idonethis](https://idonethis.com/). - -[![Build Status](https://travis-ci.org/ben-biddington/idonethis-cli.svg?branch=master)](http://travis-ci.org/ben-biddington/idonethis-cli) - -## Installation - -``` -$ gem install idonethis-cli -``` - -Due to [this defect](https://github.com/bundler/bundler/issues/1096), you may have to install rspec 3 manually. (Bundler tries to install development dependencies too.) - -## Usage - -### Configuration - -Set up your token and team (find your token [here](https://idonethis.com/api/token/)): - -``` -$ idonethis config user.token=7513375f96b158a5c42a1337f1025d4d76d1deb -``` - -``` -$ idonethis config user.team=benbiddington-personal -``` - -### List dones - -``` -$ idonethis list today -1 2015-09-21T04:42:21.832 -- Moved settings file into lib -2 2015-09-21T01:22:53.058 -- Some more refactoring -3 2015-09-21T01:13:00.111 -- [idone] Split adapters and use cases -4 2015-09-20T23:29:01.002 -- Some work in change contact (js) -5 2015-09-20T21:47:00.903 -- Do <code>backticks</code> work? -6 2015-09-20T21:46:00.053 -- Seems to work on windows, though we do get that gem warning &lt;Unresolved specs during Gem::Specification.reset&gt; -``` - -You can also list dones for the past week: - -``` -$ idonethis list week -``` - -### Add done - -``` -$ bin/idonethis new -m "Ricky Bizzness" -``` - -### Choose team - -To work against a different team, use the `-t` option. - -``` -$ idonethis list today -t benbiddington-personal-lM85 -1 2015-09-23T02:01:41.808 benbiddington-personal-lM85 -- I think this is our shared team, Ricky F -``` - -Same for adding: - -``` -idonethis new -m "Can use \`-t\` to send dones to another team" -t benbiddington-personal-lM85 -``` - -### Add dones based on commit activity [alpha] - -``` -$ idonethis git -Scanning dir </home/ben/sauce>, which has <1> repositories that have changed - -idonethis-cli (10): --- [22:07] `idonethis git` prints an activity summary --- [21:16] v0.4.0 --- [21:16] Use raw text for CLI display --- [21:14] Document `list week` --- [21:12] Add build status icon --- [21:09] Enable `rake` (runs tests) --- [21:07] v0.3.0 -- `list week` --- [21:06] Enable `idonethis list week` --- [20:55] Refactor: simplified --- [20:48] Refactor: extract function" -``` - -## Development - -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. - -To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). - -## Contributing - -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idonethis-cli. - - -## License - -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). - +A CLI for [idonethis](https://idonethis.com/). + +[![Build Status](https://travis-ci.org/ben-biddington/idonethis-cli.svg?branch=master)](http://travis-ci.org/ben-biddington/idonethis-cli) + +## Installation + +``` +$ gem install idonethis-cli +``` + +Due to [this defect](https://github.com/bundler/bundler/issues/1096), you may have to install rspec 3 manually. (Bundler tries to install development dependencies too.) + +## Usage + +### Configuration + +Set up your token and team (find your token [here](https://idonethis.com/api/token/)): + +``` +$ idonethis config user.token=7513375f96b158a5c42a1337f1025d4d76d1deb +``` + +``` +$ idonethis config user.team=benbiddington-personal +``` + +### List dones + +``` +$ idonethis list today +1 2015-09-21T04:42:21.832 -- Moved settings file into lib +2 2015-09-21T01:22:53.058 -- Some more refactoring +3 2015-09-21T01:13:00.111 -- [idone] Split adapters and use cases +4 2015-09-20T23:29:01.002 -- Some work in change contact (js) +5 2015-09-20T21:47:00.903 -- Do <code>backticks</code> work? +6 2015-09-20T21:46:00.053 -- Seems to work on windows, though we do get that gem warning &lt;Unresolved specs during Gem::Specification.reset&gt; +``` + +You can also list dones for the past week: + +``` +$ idonethis list week +``` + +### Add done + +``` +$ bin/idonethis new -m "Ricky Bizzness" +``` + +### Choose team + +To work against a different team, use the `-t` option. + +``` +$ idonethis list today -t benbiddington-personal-lM85 +1 2015-09-23T02:01:41.808 benbiddington-personal-lM85 -- I think this is our shared team, Ricky F +``` + +Same for adding: + +``` +idonethis new -m "Can use \`-t\` to send dones to another team" -t benbiddington-personal-lM85 +``` + +### Add dones based on commit activity [alpha] + +``` +$ idonethis git +Scanning dir </home/ben/sauce>, which has <1> repositories that have changed + +idonethis-cli (10): +-- [22:07] `idonethis git` prints an activity summary +-- [21:16] v0.4.0 +-- [21:16] Use raw text for CLI display +-- [21:14] Document `list week` +-- [21:12] Add build status icon +-- [21:09] Enable `rake` (runs tests) +-- [21:07] v0.3.0 -- `list week` +-- [21:06] Enable `idonethis list week` +-- [20:55] Refactor: simplified +-- [20:48] Refactor: extract function" +``` + +## Development + +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. + +To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/idonethis-cli. + + +## License + +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +