BionicReader

<a name="readme-top"></a>

<!-- PROJECT LOGO --> <br /> <div align="center"> <a href="https://github.com/dchan04/BionicReader"> <img src="images/projectlogo.png" alt="Logo" width="auto" height="300"> </a> <h3 align="center">Bionic Text Converter</h3> <p align="center"> A convenient tool to convert text into Bionic Text for faster reading. <br /> <a href="https://dchan04.github.io/BionicReader/">View Demo</a> </p> </div> <!-- TABLE OF CONTENTS --> <details> <summary>Table of Contents</summary> <ol> <li><a href="#about-the-project">About The Project</a></li> <li><a href="#screenshots">Screenshots</a></li> <li><a href="#technologies">Technologies</a></li> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#license">License</a></li> </ol> </details> <!-- ABOUT THE PROJECT -->

About the Project

The Bionic Text Converter is a user-friendly tool that extracts text from PDF, TXT, and DOCX files and converts it into bionic text.

Bionic reading is a new innovative method of reading used to improve reading speed. By guiding the eyes through the text with artificial fixation points, the reader focuses on the highlighted initial letters and lets the brain complete the word.

Although the benefits are not guaranteed, many people with dyslexia and ADHD have shared positive experiences on social media like improved focus.

Screenshots

Main Page

Example Generated PDF

<!-- Built with -->

Technologies

• 
• 
• 
• 
• 
• 

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Prerequisites

• npm

  npm install npm@latest -g
  

Installation

1. Clone the repo

   git clone https://github.com/dchan04/BionicReader.git
   

2. Install NPM packages

   npm install
   

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- ROADMAP -->

Roadmap

• [ ] Add more file compatibility for import
  • [ ] Rich Text Format (.rtf)
  • [ ] Spanish
• [ ] Add more download options
  • [ ] E-Book file format (.epub)
  • [ ] Word Document (.docx)
  • [ ] Plain Text (.txt)

See the open issues for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- CONTACT -->

Contact

Darren Chan - darrenchan1123@gmail.com

Project Link: https://github.com/dchan04/BionicReader

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE.txt for more information.

<p align="right">(<a href="#readme-top">back to top</a>)</p> <!-- MARKDOWN LINKS & IMAGES --> <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->