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

- old
+ new

@@ -1,41 +1,51 @@ -[![codebeat badge](https://codebeat.co/badges/b4067adc-06cb-4142-a985-519555be3070)](https://codebeat.co/projects/github-com-akabiru-hscode) [![Dependency Status](https://gemnasium.com/badges/github.com/akabiru/hscode.svg)](https://gemnasium.com/github.com/akabiru/hscode) [![Inline docs](http://inch-ci.org/github/akabiru/hscode.svg?branch=master)](http://inch-ci.org/github/akabiru/hscode) [![Coverage Status](https://coveralls.io/repos/github/akabiru/hscode/badge.svg?branch=master)](https://coveralls.io/github/akabiru/hscode?branch=master) [![Build Status](https://travis-ci.org/akabiru/hscode.svg?branch=master)](https://travis-ci.org/akabiru/hscode) +[![codebeat badge](https://codebeat.co/badges/b4067adc-06cb-4142-a985-519555be3070)](https://codebeat.co/projects/github-com-akabiru-hscode) [![Dependency Status](https://gemnasium.com/badges/github.com/akabiru/hscode.svg)](https://gemnasium.com/github.com/akabiru/hscode) [![Inline docs](http://inch-ci.org/github/akabiru/hscode.svg?branch=master)](http://inch-ci.org/github/akabiru/hscode) [![Coverage Status](https://coveralls.io/repos/github/akabiru/hscode/badge.svg?branch=master)](https://coveralls.io/github/akabiru/hscode?branch=master) [![Build Status](https://travis-ci.org/akabiru/hscode.svg?branch=master)](https://travis-ci.org/akabiru/hscode) [![Gem Version](https://badge.fury.io/rb/hscode.svg)](https://badge.fury.io/rb/hscode) # Hscode -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/hscode`. To experiment with that code, run `bin/console` for an interactive prompt. +Hscode is a simple `HTTP` status code lookup tool. Lookup that status code at the comfort of your own terminal.😎 -TODO: Delete this and the text above, and describe your gem - ## Installation -Add this line to your application's Gemfile: +Install it yourself as: + $ gem install hscode + +Or Add this line to your application's Gemfile: + ```ruby gem 'hscode' ``` And then execute: $ bundle -Or install it yourself as: +## Usage - $ gem install hscode +Run a quick lookup -## Usage + $ hscode -c 200 -TODO: Write usage instructions here +For a more comprehensive description, run verbosely. -## Development + $ hscode -c 200 -v -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. +List all status codes -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). + $ hscode -l +In case you forget something; run help. + + $ hscode -h + + +## Screencast +[![asciicast](https://asciinema.org/a/9vjzetmxefd86dxymbr969et2.png)](https://asciinema.org/a/9vjzetmxefd86dxymbr969et2) + ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/hscode. 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/akabiru/hscode. 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](http://opensource.org/licenses/MIT).