README.md in peekj-0.1.0 vs README.md in peekj-0.1.1

- old
+ new

@@ -1,39 +1,41 @@ # Peekj -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/peekj`. To experiment with that code, run `bin/console` for an interactive prompt. +Command line interface to interact with Jira's API. -TODO: Delete this and the text above, and describe your gem - ## Installation Add this line to your application's Gemfile: ```ruby gem 'peekj' ``` And then execute: - $ bundle + $ bundle install Or install it yourself as: $ gem install peekj ## Usage -TODO: Write usage instructions here +Enter Jira credentials and app url: -## Development + $ peekj login -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +Fetch issue summary: -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). + $ peekj summary ISSUE-KEY +Fetch issue summary from current branch name: + + $ peekj summary --current_branch + ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/peekj. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/ericlarosa/peekj. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. ## License The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).