Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

uniread

Build Status FOSSA Status Backers on Open Collective Sponsors on Open Collective Known Vulnerabilities npm License: MIT

Uniread is Spritz like CLI fast reading software.

Screencast

Content

Supported ebook types

We try to support as much as possible of ebook formats. If you have any kind of requests, feel free to create feature request in issues.

Installation / update

sudo npm install -g uniread

Usage

uniread ~/Books/somebook.epub

Developers guide

Yarn package manager

For this project development, we are using faster, yarn package manager.

To install it, run:

sudo npm install -g yarn

After that, you need to install dependencies, using:

yarn

Getting sample books for testing

Books source: https://pressbooks.com/sample-books/

To download books, run

yarn get-books

Coding Style

Coding style of this project is defined inside .editorconfig and to use it, download Editor Config plugin for your text editor.

Linting

For linting, we are using eslinter and to run it, you can just use:

yarn lint

Testing

To run tests, we use mocha.

To run it, simply:

yarn test

Authors

Also, huge thanks to these people.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

About

Uniread is Spritz like CLI fast reading software.

Resources

License

Packages

No packages published