Initial import

This commit is contained in:
Dan Milne
2020-04-22 00:18:09 +10:00
commit 0929b3eb80
18 changed files with 392 additions and 0 deletions

52
README.md Normal file
View File

@@ -0,0 +1,52 @@
# Openlib
This is a tiny client to the Open Library's [Books API](https://openlibrary.org/dev/docs/api/books)
## 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"]
```
## Development
### TODO
Write some tests
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).