Apartment Hunter

Welcome to Apartment Hunter! This gem will search Craigslist for apartments in the Greater New York area.

Installation

$ gem install apartmenthunter'

Usage

Type the following into your terminal:

$ apartmenthunter

The CLI will walk you through it's usage. First you must select a specific area in or around the city, or select all areas. Then enter the requested parameters to narrow down your search. The results will be displayed, which you will have the option to export to CSV.

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/[USERNAME]/apartmenthunter. 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.