Sha256: 0b8b87c3ca0ba96fe9e73a7854cfd45629bd05070f0b36e33ab672874fe17948

Contents?: true

Size: 1.01 KB

Versions: 7

Compression:

Stored size: 1.01 KB

Contents

# Rindle - Kindle Collections Management in Ruby

Rindle is a package of useful classes to manage the kindles content.
In mature versions it should provide an object-oriented interface to
access the collections and documents on the kindle with all their
metadata.

## Installation

Add this line to your application's Gemfile:

    gem 'rindle'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install rindle

## Usage

First load the kindle:

    Rindle.load '/path/to/root'

Then just use `Rindle::Collection` or `Rindle::Document` with an
ActiveRecord like interface:

    Rindle::Collection.first named: 'Test Collection'
    collections = Rindle::Collection.all named: /(.*)[1|2]$/
    Rindle::Document.find_by_name 'A book.pdf'
    documents = Rindle::Document.all

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Added some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

7 entries across 7 versions & 1 rubygems

Version Path
rindle-0.3.4 README.md
rindle-0.3.3 README.md
rindle-0.3.2 README.md
rindle-0.3.1 README.md
rindle-0.3.0 README.md
rindle-0.2.0 README.md
rindle-0.1.1 README.md