From 4a9677c1636195e434f6fd45c25df89ee8aa9d01 Mon Sep 17 00:00:00 2001 From: Andy Meneely Date: Tue, 30 Jan 2018 12:48:31 -0500 Subject: [PATCH] A better readme --- README.md | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 67338ba..57f2ae3 100644 --- a/README.md +++ b/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