README.md
# CanadianMergers
[![Code Climate](https://img.shields.io/codeclimate/github/kabisaict/flow.svg)](https://codeclimate.com/github/cptbrkfst/canadian_mergers)
[![Gem Version](https://badge.fury.io/rb/canadian_mergers.svg)](https://badge.fury.io/rb/canadian_mergers)
Canadian Mergers is a CLI tool that allows users to access monthly reports on concluded mergers in Canada.
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'canadian_mergers'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install canadian_mergers
## Usage
Run: `canadian_mergers` after installing the gem.
## Development
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.
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/cptbrkfst/canadian_mergers.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).