From 908346624f4726c5726a1b93cb178bf14b8933bb Mon Sep 17 00:00:00 2001 From: Dan Milne Date: Wed, 22 Apr 2020 14:23:31 +1000 Subject: [PATCH] Add some documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ff1ef9d..41561ce 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Openlib -This is a tiny client to the Open Library's [Books API](https://openlibrary.org/dev/docs/api/books) +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 @@ -34,9 +34,9 @@ Or install it yourself as: 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 +Openlibrary has a [GitHub](https://github.com/internetarchive/openlibrary) repository. -### TODO +## 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.