mirror of
https://github.com/dkam/openlib.git
synced 2025-12-28 11:14:52 +00:00
53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
# Openlib
|
|
|
|
This is a tiny client to the Open Library's [Books API](https://openlibrary.org/dev/docs/api/books). If this client doesn't meet your needs, try the other [Openlibrary client](https://github.com/jayfajardo/openlibrary).
|
|
|
|
## Installation
|
|
|
|
Add this line to your application's Gemfile:
|
|
|
|
```ruby
|
|
gem 'openlib'
|
|
```
|
|
|
|
And then execute:
|
|
|
|
$ bundle install
|
|
|
|
Or install it yourself as:
|
|
|
|
$ gem install openlib
|
|
|
|
## Usage
|
|
|
|
```
|
|
> book = Openlib::Book.new(id: '9780316030571')
|
|
> book.title
|
|
=> "Cryptonomicon"
|
|
> book.authors
|
|
=> ["Neal Stephenson"]
|
|
> book.subjects
|
|
=> ["Fiction", "World War, 1939-1945", "World War, 1939-1945 in fiction", "Data encryption (Computer science)", "Cryptography", "Literature", "Science Fiction", "Long Now Manual for Civilization", "Code and cipher stories"]
|
|
```
|
|
|
|
## Openlibrary
|
|
|
|
For more information on Openlibrary, check their [Developer center](https://openlibrary.org/developers) and the [Books API documentation](https://openlibrary.org/dev/docs/api/books).
|
|
|
|
Openlibrary has a [GitHub](https://github.com/internetarchive/openlibrary) repository.
|
|
|
|
## Development
|
|
|
|
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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]/openlib.
|
|
|
|
|
|
## License
|
|
|
|
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|