{"id":13623018,"url":"https://github.com/nemanjan00/uniread","last_synced_at":"2025-04-15T10:32:17.566Z","repository":{"id":38803011,"uuid":"135905134","full_name":"nemanjan00/uniread","owner":"nemanjan00","description":"Uniread is Spritz like CLI fast reading software. ","archived":false,"fork":false,"pushed_at":"2025-01-21T07:20:33.000Z","size":2817,"stargazers_count":274,"open_issues_count":82,"forks_count":12,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-09T22:25:48.282Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nemanjan00.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-03T13:10:26.000Z","updated_at":"2025-03-10T08:23:10.000Z","dependencies_parsed_at":"2023-01-22T14:50:15.364Z","dependency_job_id":"4da6c4e9-72c4-48de-b659-d9a820ac2883","html_url":"https://github.com/nemanjan00/uniread","commit_stats":{"total_commits":211,"total_committers":8,"mean_commits":26.375,"dds":0.07582938388625593,"last_synced_commit":"a083d010763828f70f964f6f40c6839bbeef05e2"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemanjan00%2Funiread","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemanjan00%2Funiread/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemanjan00%2Funiread/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nemanjan00%2Funiread/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nemanjan00","download_url":"https://codeload.github.com/nemanjan00/uniread/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248147882,"owners_count":21055546,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T21:01:27.081Z","updated_at":"2025-04-15T10:32:17.546Z","avatar_url":"https://github.com/nemanjan00.png","language":"JavaScript","funding_links":["https://opencollective.com/uniread"],"categories":["JavaScript"],"sub_categories":[],"readme":"# uniread\n\n[![Build Status](https://travis-ci.org/nemanjan00/uniread.svg?branch=master)](https://travis-ci.org/nemanjan00/uniread)\n[![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)\n[![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)\n[![npm](https://img.shields.io/npm/dt/uniread.svg)](https://www.npmjs.com/package/uniread)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nUniread is [Spritz](http://spritzinc.com/) like CLI fast reading software.\n\n![Screencast](https://github.com/nemanjan00/uniread/blob/master/screencast/spritz.gif?raw=true)\n\n## Content\n\n\u003c!-- vim-markdown-toc GFM --\u003e\n\n* [Supported ebook types](#supported-ebook-types)\n* [Installation / update](#installation--update)\n* [Usage](#usage)\n* [Developers guide](#developers-guide)\n  * [Yarn package manager](#yarn-package-manager)\n  * [Getting sample books for testing](#getting-sample-books-for-testing)\n  * [Coding Style](#coding-style)\n    * [Linting](#linting)\n  * [Testing](#testing)\n* [Authors](#authors)\n* [Contributors](#contributors)\n* [Backers](#backers)\n* [Sponsors](#sponsors)\n\n\u003c!-- vim-markdown-toc --\u003e\n\n## Supported ebook types\n\nWe 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).\n\n* epub (thanks to [julien-c/epub](https://github.com/julien-c/epub) library)\n* text (thanks to [pzmarzly](https://github.com/pzmarzly) and PR [#25](https://github.com/nemanjan00/uniread/pull/25))\n* pdf (thanks to [Mozilla pdf.js](https://github.com/mozilla/pdf.js) library)\n\n## Installation / update\n\n```bash\nsudo npm install -g uniread\n```\n\n## Usage\n\n```bash\nuniread ~/Books/somebook.epub\n```\n\n## Developers guide\n\n### Yarn package manager\n\nFor this project development, we are using faster, [yarn](https://yarnpkg.com/lang/en/) package manager.\n\nTo install it, run:\n\n```bash\nsudo npm install -g yarn\n```\n\nAfter that, you need to install dependencies, using:\n\n```bash\nyarn\n```\n\n### Getting sample books for testing\n\nBooks source: https://pressbooks.com/sample-books/\n\nTo download books, run\n\n```bash\nyarn get-books\n```\n\n### Coding Style\n\nCoding style of this project is defined inside `.editorconfig` and to use it, download [Editor Config plugin](https://editorconfig.org/) for your text editor.\n\n#### Linting\n\nFor linting, we are using eslinter and to run it, you can just use:\n\n```bash\nyarn lint\n```\n\n### Testing\n\nTo run tests, we use mocha.\n\nTo run it, simply:\n\n```\nyarn test\n```\n\n## Authors\n\n* [Nemanja Nedeljković](https://github.com/nemanjan00)\n\nAlso, huge thanks to [these](https://github.com/nemanjan00/uniread/graphs/contributors) people.\n\n## Contributors\n\nThis project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].\n\n\u003ca href=\"https://github.com/nemanjan00/uniread/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/uniread/contributors.svg?width=890\u0026button=false\" /\u003e\u003c/a\u003e\n\n## Backers\n\nThank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/uniread#backer)]\n\n\u003ca href=\"https://opencollective.com/uniread#backers\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/backers.svg?width=890\"\u003e\u003c/a\u003e\n\n## Sponsors\n\nSupport 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)]\n\n\u003ca href=\"https://opencollective.com/uniread/sponsor/0/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/0/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/1/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/1/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/2/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/2/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/3/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/3/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/4/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/4/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/5/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/5/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/6/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/6/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/7/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/7/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/8/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/8/avatar.svg\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/uniread/sponsor/9/website\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/uniread/sponsor/9/avatar.svg\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnemanjan00%2Funiread","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnemanjan00%2Funiread","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnemanjan00%2Funiread/lists"}