ChicagoLibraries
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/chicago_libraries
. To experiment with that code, run bin/console
for an interactive prompt.
Wrapper for the City of Chicago libraries public API. Allows you to access library information from ruby.
Installation
Add this line to your application's Gemfile:
gem 'chicago_libraries'
And then execute:
$ bundle
Or install it yourself as:
$ gem install chicago_libraries
Usage
To get all Chicago public library information, run this code:
libraries = ChicagoLibraries::Library.all
To get all Chicago public library information using a search keyword, run this code:
libraries = ChicagoLibraries::Library.search('park')
replace 'park' with your own search keyword.
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]/chicago_libraries.