Skip to content

ellenupark/acnh_villager

Repository files navigation

AcnhVillager

Description

ACNH Villager is a Command Line Interface (CLI) that provides detailed information on villagers from Animal Crossing New Horizons. It is built with object oriented Ruby and utilizes data from an outside API.

Usage

Navigate to the root directory. Then, execute the bin file ./bin/acnh_villager. A list of villagers will be displayed.

Select a villager by number to view detailed information.

Installation

Add this line to your application's Gemfile:

gem 'acnh_villager'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install acnh_villager

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/ellenupark/acnh_villager.

License

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

Further Information

Personal Website | LinkedIn | Blog

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published