README.md in best-hiking-trails-0.1.1 vs README.md in best-hiking-trails-0.1.2

- old
+ new

@@ -1,36 +1,29 @@ # BestHikingTrails -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/best_hiking_trails`. To experiment with that code, run `bin/console` for an interactive prompt. +Best Hiking Trails is a web scraper with a CLI interface that shows you the top 10 hiking trails and information about each trail. -TODO: Delete this and the text above, and describe your gem - ## Installation -Add this line to your application's Gemfile: +Run the following command in your terminal: ```ruby -gem 'best_hiking_trails' +gem install best_hiking_trails ``` -And then execute: - - $ bundle - -Or install it yourself as: - - $ gem install best_hiking_trails - ## Usage -TODO: Write usage instructions here +Run best-hiking-trails to get started. This will then show you a top 10 list of hiking trails and their corresponding numbers. Enter the number of the trail you want more information about, List to relist the trails, and/or Exit to exit the program. ## 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. +After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` 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](https://rubygems.org). ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/best_hiking_trails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +Bug reports and pull requests are welcome on GitHub at https://github.com/rgylling/best_hiking_trails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. +## License + +The gem is available as open source under the terms of the MIT License.