Skip to content
Uniread is Spritz like CLI fast reading software.
JavaScript Shell
Branch: master
Clone or download
Latest commit ef02720 Jul 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin unify error message format Oct 10, 2018
devScripts Update dependencies Jul 24, 2018
screencast Screencast Jun 7, 2018
src Fix for npm Jul 23, 2019
tests Fix tests Apr 26, 2019
.editorconfig format README according to markdownlint Oct 10, 2018
.eslintrc.json Fix eslint typo and lint Jun 3, 2018
.fossa.yml Travis fix Jul 24, 2018
.gitignore Fix for npm Jul 23, 2019
.snyk fix: .snyk & package.json to reduce vulnerabilities Jul 4, 2019
.tern-project Tern project Jun 13, 2018
.travis.yml Temporary fix test Oct 10, 2018
LICENSE Create LICENSE Jun 7, 2018
README.md fix broken link in README Oct 12, 2018
index.js
package.json
yarn.lock Fix for npm Jul 23, 2019

README.md

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]

You can’t perform that action at this time.