Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/nemanjan00/uniread

Uniread is Spritz like CLI fast reading software.
https://github.com/nemanjan00/uniread

Last synced: 3 months ago
JSON representation

Uniread is Spritz like CLI fast reading software.

Host: GitHub
URL: https://github.com/nemanjan00/uniread
Owner: nemanjan00
License: mit
Created: 2018-06-03T13:10:26.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-05-07T17:05:04.000Z (9 months ago)
Last Synced: 2024-05-22T19:28:28.157Z (9 months ago)
Language: JavaScript
Size: 2.3 MB
Stars: 269
Watchers: 7
Forks: 10
Open Issues: 75
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-github-repos - nemanjan00/uniread - Uniread is Spritz like CLI fast reading software. (JavaScript)

README

        # uniread

[![Build Status](https://travis-ci.org/nemanjan00/uniread.svg?branch=master)](https://travis-ci.org/nemanjan00/uniread)

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fnemanjan00%2Funiread.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fnemanjan00%2Funiread?ref=badge_shield)

[![Backers on Open Collective](https://opencollective.com/uniread/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/uniread/sponsors/badge.svg)](#sponsors) [![Known Vulnerabilities](https://snyk.io/test/github/nemanjan00/uniread/badge.svg)](https://snyk.io/test/github/nemanjan00/uniread)

[![npm](https://img.shields.io/npm/dt/uniread.svg)](https://www.npmjs.com/package/uniread)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Uniread is [Spritz](http://spritzinc.com/) like CLI fast reading software.

![Screencast](https://github.com/nemanjan00/uniread/blob/master/screencast/spritz.gif?raw=true)

## Content

* [Supported ebook types](#supported-ebook-types)

* [Installation / update](#installation--update)

* [Usage](#usage)

* [Developers guide](#developers-guide)

  * [Yarn package manager](#yarn-package-manager)

  * [Getting sample books for testing](#getting-sample-books-for-testing)

  * [Coding Style](#coding-style)

    * [Linting](#linting)

  * [Testing](#testing)

* [Authors](#authors)

* [Contributors](#contributors)

* [Backers](#backers)

* [Sponsors](#sponsors)

## 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](https://github.com/nemanjan00/uniread/issues).

* epub (thanks to [julien-c/epub](https://github.com/julien-c/epub) library)

* text (thanks to [pzmarzly](https://github.com/pzmarzly) and PR [#25](https://github.com/nemanjan00/uniread/pull/25))

* pdf (thanks to [Mozilla pdf.js](https://github.com/mozilla/pdf.js) library)

## Installation / update

```bash

sudo npm install -g uniread

```

## Usage

```bash

uniread ~/Books/somebook.epub

```

## Developers guide

### Yarn package manager

For this project development, we are using faster, [yarn](https://yarnpkg.com/lang/en/) package manager.

To install it, run:

```bash

sudo npm install -g yarn

```

After that, you need to install dependencies, using:

```bash

yarn

```

### Getting sample books for testing

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

To download books, run

```bash

yarn get-books

```

### Coding Style

Coding style of this project is defined inside `.editorconfig` and to use it, download [Editor Config plugin](https://editorconfig.org/) for your text editor.

#### Linting

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

```bash

yarn lint

```

### Testing

To run tests, we use mocha.

To run it, simply:

```

yarn test

```

## Authors

* [Nemanja Nedeljković](https://github.com/nemanjan00)

Also, huge thanks to [these](https://github.com/nemanjan00/uniread/graphs/contributors) people.

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].



## Backers

Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/uniread#backer)]



## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/uniread#sponsor)]