Skip to content

morgvanny/monster_index

Repository files navigation

And then execute:

$ bundle install

Or install it yourself as:

$ gem install monster_index

Usage

After installation, you can run the Monster Index CLI by executing:

$ monster_index

Follow the on-screen instructions to:

  • List all monsters
  • List monsters starting with a specific letter
  • View detailed stats for a specific monster

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/morgvanny/monster_index. 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 Monster Index project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

CLI for scraping and seeing details about Dungeons and Dragons monsters

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published