Project

sea_life

0.0
No commit activity in last 3 years
No release in over 3 years
A simple CLI Gem that provides information about various sea creatures.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.16
>= 0
~> 10.0

Runtime

>= 1.8.0, ~> 1.8
 Project Readme

SeaLife

SeaLife is a simple CLI Gem that scrapes information from Oceana's Marine Life Encyclopedia and provides information about sea creatures.

Installation

Gem can be installed by:

$ gem install sea_life

Usage

Run the CLI by typing:

$ sea_life

After the CLI has loaded you will be presented with a list of categories. Enter the number of the category you'd like to see and press enter. The application will present you with a list of animals that belong to that category. You can then choose one of these animals by entering the number of your selection.

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/mattetress/sea_life. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the SeaLife project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.