Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tippenein/ebook_library

generate an organized library from a local ebook directory.
https://github.com/tippenein/ebook_library

Last synced: 12 days ago
JSON representation

generate an organized library from a local ebook directory.

Awesome Lists containing this project

README

        

# EbookLibrary

generate an organized library from a local ebook directory.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'ebook_library'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install ebook_library

## Usage

in a rake task you might want to run

```
EbookLibrary::Gatherer.gather
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then,
run `rake false` 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).

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/[USERNAME]/ebook_library. This project is intended to be a
safe, welcoming space for collaboration, and contributors are expected to
adhere to the [Contributor Covenant](contributor-covenant.org) code of
conduct.