Uniread is Spritz like CLI fast reading software.
- Supported ebook types
- Installation / update
- Developers guide
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.
- epub (thanks to julien-c/epub library)
- text (thanks to pzmarzly and PR #25)
- pdf (thanks to Mozilla pdf.js library)
Installation / update
sudo npm install -g uniread
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:
Getting sample books for testing
Books source: https://pressbooks.com/sample-books/
To download books, run
Coding style of this project is defined inside
.editorconfig and to use it, download Editor Config plugin for your text editor.
For linting, we are using eslinter and to run it, you can just use:
To run tests, we use mocha.
To run it, simply:
Also, huge thanks to these people.
This project exists thanks to all the people who contribute. [Contribute].
Thank you to all our backers!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]