README.md
# Battle Boats [](https://badge.fury.io/rb/battle_boats) [](https://travis-ci.org/Thomascountz/battle_boats) [](https://codeclimate.com/github/Thomascountz/battle_boats/maintainability) [](https://codeclimate.com/github/Thomascountz/battle_boats/test_coverage)
Battle Boats is a ruby library implementation of [Battleship](https://en.wikipedia.org/wiki/Battleship_%28game%29)!
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'battle_boats'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install battle_boats
## Usage
Enter
```
$ battle_boats
```
into the terminal. You should see a welcome message:
```
Welcome to Battle Boats!
```
## 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/thomascountz/battle_boats. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the BattleBoats project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/battle_boats/blob/master/CODE_OF_CONDUCT.md).