dkam/openlib
1
0
Fork 0
mirror of https://github.com/dkam/openlib.git synced 2025-12-28 03:04:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some documentation links to Openlibrary

Browse Source
This commit is contained in:
Dan Milne
2020-04-22 14:19:30 +10:00
parent 20d670d6e9
commit 0e754d26a4
2 changed files with 4 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -2,8 +2,6 @@
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:
@@ -32,12 +30,14 @@ Or install it yourself as:
=> ["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).
## 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).