kwame-mintah / bionic-speed-reader-browser-extension

A simple chrome extension using Bionic Reading (BR®) API.

Bionic Speed Reader Browser Extension

A simple browser extension using Bionic Reading API, provided by RapidAPI.

🚧 👷 Currently in the early stages of development 👷 🚧

Note

Extension performance is dependent on the Bionic Reading API.

Features

• Convert entire webpage use the URL (webpages may not keep their original formatting)
• Convert each paragraph on the page to Bionic format
• Convert selected text only to Bionic format

Prerequisites

1. Have a RapidAPI account,
2. Subscribed to Bionic Reading API.

Installation Instructions

1. Navigate to the releases page of the github repository.
2. Find the release you wish to download, or download the most recent release version.
3. Expand the 'Assets' section and download the 'Source code (zip)'.
4. Unzip the file and you should have a folder named bionic-speed-reader-browser-extension-*.*.*.
5. In Chrome / Brave / Edge go to the following page (brave://extensions / chrome://extensions / edge://extensions).
6. On the extension page, enable developer mode.
7. Click on "Load unpacked" locate the bionic-speed-reader-browser-extension-*.*.* folder and open it.

Usage

1. On your browsers extension page, click 'Details' on Bionic Speed Reader Browser Extension.
2. Next click 'Extension options'.
3. Enter your RapidAPI Key that is subscribed to the Bionic Reading API.
4. You can change your fixation (default: 1) and saccade (default: 10).
5. If you want to preview your changes, click 'Save' first, then 'Preview' button.
6. Highlight text on a page and right click and select 'Bionic Speed Reading convert text ...'
7. Alternately, not selecting any text, right click the page and select 'Bionic Speed Reading convert page'

FAQ

Is it safe for me to enter my RapidAPI key?

This extension uses your browsers local storage meaning, the API key is stored locally on your machine and it is only used when making a request to RapidAPI. Removing the extension from your browser also means that this data is removed.

How do I request an RapidAPI key for Bionic Reading API?

Documentation of using RapidAPI can be found here.

Web browser support

Brave	Chrome	Edge
V1.38.119	V101.0.4951.67	V101.0.1210.53

Improvements

• Add styling to extensions HTML pages,
• Use a pop-up for the API response, rather than opening in a new tab,
• Better error handling, e.g. inform the user if they have reached their request limit for the day.
• Tidy-up the code 😅

Disclaimer

This project is not affiliated with Bionic Reading (BR®). All trademarks are the property of their respective owners.

For more information on Bionic Reading and how it works, please see: https://bionic-reading.com/about/. Additionally, you can find the official Chrome extension here.

bionic-speed-reader-browser-extension's Issues

can't change permision to read and change site data .

I am trying to set the permission to "On all sites " but that option is disabled (gray color on option ). and also it is also not changing text to bionic when clicking the extension with the current setting. ( Works in preview)

Bionic Reading® Legal Stuff

This isn't a bug, but I just want to inform y'all that the wonderful® folks at Bionic Reading® have decided to crack down on any open source projects that involves Bionic Reading®. It is advised to remove all mentioning of Bionic Reading® for now to avoid legal repercussions.

Context

Rename project to to not include 'Bionic Reading'

Project is currently named Bionic Reading Chrome Extension, this is because the browsers I personally use are chrome based e.g. Brave and Edge.

Removing 'chrome' from the project name, may suggest it works with other browsers. However, my understanding is manifest 3 isn't yet full supported in Firefox. But it seems that it's possible to get it working in Firefox, but may take sometime.

Project read me could be updated to inform users that chrome based browsers are currently supported and future plans to make it available on other browsers?

Benefits of renaming would be more views on the project, stars etc. Downside is that anyone who has cloned, will need update their remote to continue to pull the latest changes.