README.md in saddler-reporter-text-0.0.1 vs README.md in saddler-reporter-text-0.1.0
- old
+ new
@@ -1,14 +1,26 @@
# Saddler::Reporter::Text
[](http://badge.fury.io/rb/saddler-reporter-text)
[](https://travis-ci.org/packsaddle/ruby-saddler-reporter-text)
-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/saddler/reporter/text`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Reporters
-TODO: Delete this and the text above, and describe your gem
+This provides saddler reporters for Text.
+* Text
+
+## Usage
+
+```
+$ saddler report \
+ --require saddler/reporter/text \
+ --reporter Saddler::Reporter::Text
+```
+
+like this.
+
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -21,22 +33,18 @@
Or install it yourself as:
$ gem install saddler-reporter-text
-## Usage
-
-TODO: Write usage instructions here
-
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/saddler-reporter-text/fork )
+1. Fork it ( https://github.com/packsaddle/ruby-saddler-reporter-text/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request