CigarFreaks

Allows the user to view the most current and top rated cigars in the world. Simply run cigar_freaks in your terminal to load the program. The instructions will be easily explained!


License
MIT
Install
gem install CigarFreaks -v 0.1.1

Documentation

CigarFreaks

Welcome to CigarFreaks! This is a dynamic gem that will keep you up-to-date on the top ten highest valued cigars. Information will include a description of the cigar's:

  1. Tasting note
  2. Ring gauge
  3. Body
  4. Size
  5. Length
  6. Filler
  7. Binder
  8. Wrapper
  9. Price

The data updates every time the program is ran. So keep in mind to check back regularly!! <3

Installation

Add this line to your application's Gemfile:

gem 'CigarFreaks'

And then execute:

$ bundle

Or install it yourself as:

$ gem install CigarFreaks

Usage

Once you have this gem loaded, simply execute:

bin/cigar_freaks

to get everything up and running! Once the program loads, you will be given a list of ten current cigars ordered 1 to 10. In order to retrieve information regarding the cigar in question, simply enter in the number associated with its rank. Simple!

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/catalanowebdevelopment/CigarFreaks. 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 CigarFreaks project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.