https://github.com/athityakumar/kindle_fortune

A Ruby CLI gem that provides fortune cookie messages on your Terminal, based on the highlights on your Kindle device.
https://github.com/athityakumar/kindle_fortune

Last synced: 9 months ago
JSON representation

A Ruby CLI gem that provides fortune cookie messages on your Terminal, based on the highlights on your Kindle device.

• Host: GitHub
• URL: https://github.com/athityakumar/kindle_fortune
• Owner: athityakumar
• License: mit
• Created: 2017-11-28T13:01:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-28T13:13:20.000Z (over 8 years ago)
• Last Synced: 2024-10-19T00:15:44.844Z (over 1 year ago)
• Language: Ruby
• Size: 10.7 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Kindle Fortune

[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](http://forthebadge.com)

[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](http://forthebadge.com)

[![Gem Version](https://badge.fury.io/rb/kindle_fortune.svg)](https://badge.fury.io/rb/kindle_fortune)

[![Build Status](https://travis-ci.org/athityakumar/kindle_fortune.svg?branch=master)](https://travis-ci.org/athityakumar/kindle_fortune)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=shields)](http://makeapullrequest.com)

A Ruby CLI gem that provides fortune cookie messages on your Terminal, based on the highlights on your Kindle device.

# Table of contents

- [Usage](#usage)

- [Installation](#installation)

- [Updating](#updating)

- [Uninstallation](#uninstallation)

- [Contributing](#contributing)

- [License](#license)

# Usage

[(Back to top)](#table-of-contents)

1. With default arguments : `kindle_fortune`

![image](https://user-images.githubusercontent.com/17109060/33320930-ca3235a6-d469-11e7-8595-aa628a88a75e.png)

2. With path arguments : `kindle_fortune [PATH]`

`[PATH]` is the absolute path to your `My collections.txt` file of your Kindle device.

# Installation

[(Back to top)](#table-of-contents)

1. Install Ruby (preferably, version > 2.1)

2. Install the [kindle_fortune](https://rubygems.org/gems/kindle_fortune/) ruby gem with `gem install kindle_fortune`

3. Preferably, install the `cowsay` CLI.

4. Start using `kindle_fortune` :tada:

# Updating

[(Back to top)](#table-of-contents)

Want to update to the latest version of `kindle_fortune`?

```sh

gem update kindle_fortune

```

# Uninstallation

[(Back to top)](#table-of-contents)

Want to uninstall and revert back to the old style? No issues (sob). Please feel free to open an issue regarding how we can enhance `kindle_fortune`.

```sh

gem uninstall kindle_fortune

```

# Contributing

[(Back to top)](#table-of-contents)

Your contributions are always welcome! Please have a look at the [contribution guidelines](CONTRIBUTING.md) first. :tada:

# License

[(Back to top)](#table-of-contents)

The MIT License (MIT) 2017 - [Athitya Kumar](https://github.com/athityakumar/). Please have a look at the [LICENSE.md](LICENSE.md) for more details.