glyphh
v1.0.6
Published
[![npm version](https://badge.fury.io/js/glyphh.svg)](https://badge.fury.io/js/glyphh)
Downloads
115
Readme
Glyphh
Glyphh is a tool to read EPUB files in the terminal with a beautiful user experience.
Table of Contents
Installation
To install and use Glyphh, you can run it directly using npx
:
npx glyphh
Usage
After running the command, Glyphh will guide you through a series of prompts to select and read your EPUB files.
Local Development
If you want to contribute to Glyphh or run it locally for development purposes, follow these steps:
Clone the repository:
git clone https://github.com/NewtonFernandis/glyph.git
cd glyph
Install dependencies:
npm install
Run the tool locally:
node index.js
Contributing
We welcome contributions! If you would like to contribute to Glyphh, please follow these steps:
- Fork the repository on GitHub
- Create a new branch for your feature or bugfix
- Make your changes and commit them with descriptive messages
- Push your changes to your fork
- Create a pull request on the main repository
- Please make sure your code adheres to the project's coding standards and includes appropriate tests.