Skip to content

Commit

Permalink
A better readme
Browse files Browse the repository at this point in the history
  • Loading branch information
andymeneely committed Jan 30, 2018
1 parent 8f6e457 commit 4a9677c
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions README.md
@@ -1,26 +1,17 @@
# InteractiveChurn [![Build Status](https://secure.travis-ci.org/andymeneely/interactive_churn.svg?branch=master)](https://travis-ci.org/andymeneely/interactive_churn) [![Coverage Status](https://img.shields.io/coveralls/andymeneely/interactive_churn.svg)](https://coveralls.io/r/andymeneely/interactive_churn)

TODO: Write a gem description

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'interactive_churn'
```

And then execute:

$ bundle
This is a gem that is not posted on RubyGems (yet). To install it locally, you'll need to:

Or install it yourself as:
* `bundle install` from the root of the repo
* `rake install` to install the gem locally

$ gem install interactive_churn
From there, you can use the `ichurn` binary anywhere.

## Usage

TODO: Write usage instructions here
Usage instructions can be found by running `ichurn -h`

## Contributing

Expand Down

0 comments on commit 4a9677c

Please sign in to comment.