README.md in ofx_ruby-0.0.14 vs README.md in ofx_ruby-0.0.15
- old
+ new
@@ -1,39 +1,47 @@
-# OfxRuby
+[coin]:https://raw.githubusercontent.com/bigfatgreg/ofx_ruby/master/doc/img/coin.gif
-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/ofx_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Code Climate](https://codeclimate.com/repos/5817e08271a9496d910040e2/badges/aa4aa26c5907d13625de/gpa.svg)](https://codeclimate.com/repos/5817e08271a9496d910040e2/feed)
+[![Issue Count](https://codeclimate.com/repos/5817e08271a9496d910040e2/badges/aa4aa26c5907d13625de/issue_count.svg)](https://codeclimate.com/repos/5817e08271a9496d910040e2/feed)
+[![Test Coverage](https://codeclimate.com/repos/5817e08271a9496d910040e2/badges/aa4aa26c5907d13625de/coverage.svg)](https://codeclimate.com/repos/5817e08271a9496d910040e2/coverage)
+[![Build Status](https://drone.graveflex.com/api/badges/bigfatgreg/ofx_ruby/status.svg)](https://drone.graveflex.com/bigfatgreg/ofx_ruby)
-TODO: Delete this and the text above, and describe your gem
+
+![coin]
+
+#OFX
+WIP ofx gem built for my rather specific needs.
+
## Installation
Add this line to your application's Gemfile:
```ruby
-gem 'ofx_ruby'
+gem 'ofx_ruby', require: 'ofx'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ofx_ruby
-## Usage
+## Use
-TODO: Write usage instructions here
+Take a look at the tests for usage examples.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, 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).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ofx_ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bigfatgreg/ofx_ruby. Pull requests must have tests. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](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).