Skip to content

A CLI Gem providing information on places to run, swim and hike in all five NYC boroughs.

License

Notifications You must be signed in to change notification settings

brennenawana/run-swim-hike-nyc

Repository files navigation

RunSwimHikeNYC

Welcome to RunSwimHikeNYC! This is a simple CLI Gem allowing you to discover all the places to Run, Swim or Hike in all five boroughs of NYC. All information is provided by and scraped from http://www.nycgovparks.org/

Also check out my blog post about the making of this Gem at: /ruby/gem/cli/2016/02/29/building-cli-gem.html

Enjoy, contribute and comment!

Installation

Add this line to your application's Gemfile:

gem 'run-swim-hike-nyc'

And then execute:

$ bundle

Or install it yourself as:

$ gem install run-swim-hike-nyc

Usage

Type run-swim-hike in your command line to run gem.

Use the numbered menus to navigate:

  • Type exit at anytime to quit the program.
  • Type reset at anytime to return to the main menu.

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/[USERNAME]/run-swim-hike-nyc. 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.

About

A CLI Gem providing information on places to run, swim and hike in all five NYC boroughs.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published