Sha256: e5c50784eaa3aeda799ee7a590f153767fd3dc4ebf0c327ac46176271a14e350

Contents?: true

Size: 1.17 KB

Versions: 2

Compression:

Stored size: 1.17 KB

Contents

# NycNeighborhoods

Simple gem that outputs the NYC neighborhood name of a given ZIP Code.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'nyc_neighborhoods'
```

And then execute:

    $ bundle install

Or install it yourself as:

    $ gem install nyc_neighborhoods

## Usage

Currently only has one class method, which accepts both integers and strings:
```ruby
NycNeighborhoods.neighborhood(11210) # => "Flatbush"
```

## 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](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/nichol88/nyc_neighborhoods.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
nyc_neighborhoods-0.1.6 README.md
nyc_neighborhoods-0.1.5 README.md