Skip to content
Having trouble finding something to read? Enter a word or phrase and this CLI will make book suggestions for you!
Ruby Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
Gemfile.lock
LICENSE.txt
NOTES.md
README.md
Rakefile
reader.gemspec

README.md

Reader

Welcome to Reader! This CLI makes it easy to find great books to read. Enter any word or phrase, and it will show you five books matching your query. You can search as many times as you like, and add titles you're interested in to a reading list.

Installation

  1. cd into the directory you'd like Reader to live in, or make a new one.
  2. Fork and clone this repository.
  3. Run bundle install to install required gems.
  4. Open the program in your text editor of choice.
  5. You will need to supply your own Google Books API key for Reader to function. Just follow these directions to set one up.
  6. Create a file in the root directory called .env
  7. In .env, add your API key like so: GOOGLE_BOOKS_KEY='enter your personal API key here' (This file is gitignored in case you are developing on this program).
  8. Run rspec to test. Green means you're good to go!

Usage

  1. Run ruby ./bin/read to start the program.
  2. Enter a word or phrase to search for relevant books.
  3. A numbered list of five books will appear, showing title, author, and publisher.
  4. Add a book to your reading list by entering the corresponding number.
  5. You can then view your most recent search, or search again.
  6. When you finish searching, view your list to see all the books you are interested in. Be sure to copy this list elsewhere, since it will not persist after you exit the program.
  7. Obtain those books from your supplier of choice and read to your heart's content!

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.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/palledorous/reader. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.