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

Overview

Bionic Speed Reader Browser Extension

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

🚧 👷 Currently in the early stages of development 👷 🚧

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-reading-extension-*.
  5. In Brave/Edge go to the following page (brave://extensions/ / edge://extensions).
  6. On the extension page, enable developer mode.
  7. Click on "Load unpacked" locate the bionic-reading-extensions-* 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
Brave
Chrome
Chrome
Edge
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.

Comments
  • Feature/use url for convert

    Feature/use url for convert

    Description

    This uses the URL of the page for the bionic reading API request rather than doing a separate request for each text block for convertPage. The goal / motivation is to limit the number of API calls required assuming people will want to use the Basic plan. Motivation generally is that I really want to use this extension lol

    Also secondary is that I'm working on another PR to handle a quota limit error from the api and it's easier to handle that if each type of conversion only makes one api request

    Type of change

    Please delete options that are not relevant.

    • [x] New feature (non-breaking change which adds functionality)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    enhancement 
    opened by edcohen08 2
  • can't change permision to read and change site data .

    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)

    bug 
    opened by isahillohiya 2
  • Bionic Reading® Legal Stuff

    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 legal notice

    opened by jomamaaye 1
  • feat(convert): allow the user to toggle between using page url or paragraphs for pages

    feat(convert): allow the user to toggle between using page url or paragraphs for pages

    Description

    new section has been added to the options page, 'experimental features' to allow users to toggle different features. this has been added as converting a page using an url causes the page to lose its formatting and not all content is converted to bionic reading. users have the option to opt-out of using the webpage url to convert and use the websites paragraphs, which does not affect the page format, but makes more api calls.

    Type of change

    Please delete options that are not relevant.

    • [x] New feature (non-breaking change which adds functionality)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    opened by kwame-mintah 1
  • feat(options): apply same styling used on popup to options page

    feat(options): apply same styling used on popup to options page

    Description

    options page has been updated to have the css styling that is present on popup.html e.g. updated buttons, font, spacing etc. and add homepage url to project readme documentation.

    Fixes # (issue)

    Type of change

    • [x] New feature (non-breaking change which adds functionality)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    opened by kwame-mintah 0
  • docs(readme): update installation instructions to reflect new project name

    docs(readme): update installation instructions to reflect new project name

    Description

    the asset downloaded from releases will have the name of bionic-speed-reader-browser-extension-*.*.* as the projects name has changed.

    Fixes #33

    Type of change

    Please delete options that are not relevant.

    • [x] This change requires a documentation update

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    documentation 
    opened by kwame-mintah 0
  • Add bionic link

    Add bionic link

    Description

    Add bionic link

    Fixes # (issue)

    Type of change

    Please delete options that are not relevant.

    • [x] Bug fix (non-breaking change which fixes an issue)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    bug 
    opened by fwzmhmd 0
  • Fix/color not defined

    Fix/color not defined

    Description

    Fix colour not defined error

    Fixes # (issue)

    Type of change

    Please delete options that are not relevant.

    • [x] Bug fix (non-breaking change which fixes an issue)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    bug 
    opened by fwzmhmd 0
  • Fix/fix highlighted colour in settings

    Fix/fix highlighted colour in settings

    Description

    • Fix highlight colour in settings
    • Fix formatting from single to double quotes
    • Add visual change when button is saved
    • Add save functionality when settings are saved

    Type of change

    Please delete options that are not relevant.

    • [x] Bug fix (non-breaking change which fixes an issue)

    Checklist:

    • [x] I have performed a self-review of my code
    • [x] Any dependent changes have been merged and published in downstream modules
    • [x] My code follows the style guidelines of this project
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    opened by fwzmhmd 0
  • fix(options): resolve issue with preivew no longer being displayed

    fix(options): resolve issue with preivew no longer being displayed

    Description

    recent changes broke the preview text not being displayed on the options page, due to isWebpageConvert parameter not being passed.

    Fixes # (issue)

    Type of change

    Please delete options that are not relevant.

    • [x] Bug fix (non-breaking change which fixes an issue)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [x] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [x] Any dependent changes have been merged and published in downstream modules
    bug 
    opened by kwame-mintah 0
  • Style response page with reader like view

    Style response page with reader like view

    Description

    Made visualy changes to how the response page is displayed when text is converted

    Type of change

    Please delete options that are not relevant.

    • [x] New feature (non-breaking change which adds functionality)

    Checklist:

    • [x] My code follows the style guidelines of this project
    • [x] I have performed a self-review of my code
    • [x] I have commented my code, particularly in hard-to-understand areas
    • [ ] I have made corresponding changes to the documentation
    • [x] My changes generate no new warnings
    • [ ] Any dependent changes have been merged and published in downstream modules
    enhancement 
    opened by fwzmhmd 0
Releases(v0.2.1)
  • v0.2.1(May 27, 2022)

    v0.2.1 (2022-05-27)

    Fix

    • options: resolve issue with preview text no longer displaying bionic reading format when users clicks the preview button

    Full Changelog: https://github.com/kwame-mintah/bionic-speed-reader-browser-extension/commits/v0.2.1

    Source code(tar.gz)
    Source code(zip)
  • v0.2.0(May 27, 2022)

    v0.2.0 (2022-05-27)

    Feat

    • convert: allow the user to toggle between using page url or paragraphs for pages

    Refactor

    • permissions: remove tabs from list of extension permissions

    Thank you to

    • @edcohen08 made their first contribution in https://github.com/kwame-mintah/bionic-reading-chrome-extension/pull/19
    • @fwzmhmd
    • @kwame-mintah

    Full Changelog: https://github.com/kwame-mintah/bionic-reading-chrome-extension/commits/v0.2.0

    Source code(tar.gz)
    Source code(zip)
  • v0.1.0(May 24, 2022)

    v0.1.0 (2022-05-24)

    Feat

    • convert: allow users ability to convert a webpage to bionic reading
    • background: implement loading selected text as a bionic in a new tab
    • options: change button to reflect users current settings

    Refactor

    • axios: remove external axios dependency files

    Fix

    • options: stop preview text being requested on page load

    Contributors

    • @fwzmhmd
    • @LordAndy316
    • @kwame-mintah

    Full Changelog: https://github.com/kwame-mintah/bionic-reading-chrome-extension/commits/v0.1.0

    Source code(tar.gz)
    Source code(zip)
Owner
Kwame Mintah
Your big words hold no power here.
Kwame Mintah
Firefox Extension for Smart Reading - Bionic Reading

Smart Reader - Bionic Reading Smart Reader or Bionic reading is a way to keep our focus on the web. The fact that the beginnings of words are bolded,

Poucous 27 Dec 17, 2022
A dead-simple Bookmarklet and Chrome Extension implementation of something like Bionic Reading

What is it? Inspired by Bionic Reading, this Bookmarklet modifies a webpage to display the first half of each word in bold. Can also be installed as a

null 35 Dec 5, 2022
A Chrome Extension for Bionic Reading on ANY website!

bionic-reading A Chrome Extension for Bionic Reading on ANY website! How it works Below is a screenshot demonstrating how the extension works by boldi

Ansh 3k Jan 4, 2023
A Browser Extension for Bionic Reading on ANY website!

Jiffy Reader A Browser Extension for Bionic Reading on ANY website! How it works Below is a screenshot demonstrating how the extension works by boldin

Ansh 3k Jan 9, 2023
An Open-Source JavaScript Implementation of Bionic Reading.

bionic-reading Try on Runkit or Online Sandbox An Open-Source JavaScript Implementation of Bionic Reading API. ⚙️ Install npm i bionic-reading yarn ad

shj 127 Dec 16, 2022
An Open-Source JavaScript Implementation of Bionic Reading.

TextVide (vide; Latin for "see") Support all languages that separate words with spaces Try on Runkit or Online Sandbox An Open-Source JavaScript Imple

shj 127 Dec 16, 2022
Eth-explorers-extension - Chrome extension to open Ethereum addresses & transaction hash from any page on popular explorers + dashboards

eth-explorers-extension(s) This repository contains two folders with two extensions that work for address and transactions respectively. 1. eth-addres

Apoorv Lathey 71 Jan 6, 2023
AdsPower supports Local API, which has functions like reading and writing account configuration information, opening and closing browsers, searching for accounts.

AdsPower supports Local API, which has functions like reading and writing account configuration information, opening and closing browsers, searching for accounts. Besides, it can cooperate with Selenium and Puppeteer to execute browser operations automatically.

AdsPower Official 20 Dec 1, 2022
A simple firefox/chrome extension adds Sci-Hub direct link access on publishing websites

Sci-Hub injector extension Supported sites PubMed Nature Science Direct Taylor & Francis Springer Link (article, book, chapter, protocol, reference wo

Dany 15 May 7, 2022
🎯 Wallet Lite is a Quick and Simple way to use your Tokens of Lunes Blockchain in a light Chrome extension

Lunes Wallet Lite Offered by: Lunes Installing Web store: Lunes Lite will be available on Chrome Web Store Build: Requisites NodeJS (16 or higher) Git

Lunes Platform 10 Oct 25, 2022
A Zotero add-on that scans your Markdown reading notes, tags the associated Zotero items, and lets you open notes for the Zotero items in Obsidian.

Zotero Obsidian Citations Adds colored tags to Zotero items that have associated Markdown notes stored in an external folder. Open an associated Markd

Dae 210 Jan 4, 2023
Node.js module for verifying Plumo proofs and reading states based on it

plumo-verifier Node.js module for verifying Plumo proofs and reading states based on it. Plumo is a SNARK-based light client verifier for the Celo blo

Celo 3 Dec 15, 2022
Well Read is a website for tracking your reading of long book series.

Read without losing the plot. Well Read helps you organize your notes about books you're reading, so you're never lost when starting a new volume.

null 3 Dec 15, 2022
Read without losing the plot. Well Read helps you organize your notes about books you're reading, so you're never lost when starting a new volume.

Well Read Well Read is a website for tracking your reading of long book series. I made this to track how many pages I read in a session and to better

null 3 Dec 15, 2022
An Obsidian Plugin that allows to export tables from a pane in reading mode to CSV files.

Obsidian Plugin "Table to CSV Exporter" This is my very first attempt in writing a plugin for Obsidian. I didn't even know TypeScript before (but Java

Stefan Wolfrum 26 Dec 27, 2022
A plugin for obsidian to focus and highlight on a specific heading in Reading mode.

Focus and Highlight A plugin for obsidian to focus on a specific paragraph in Reading mode. Features Focus on a specific heading and its children when

Bo-Yi Tsai 22 Dec 21, 2022
cross-platform Deno library for writing and reading clipboard.

deno-clippy This is cross-platform Deno library for writing and reading clipboard. You can read from/write image and text. This library uses Rust's ar

skanehira 34 Dec 3, 2022
A one-stop app to manage and organize your daily reading habits!

Reading Tracker with Local Authorization This is a place where you can write down all the books you plan to read, are currently reading, have finished

Nathan Folkman 4 Sep 9, 2022
Desktop app for reading and downloading manga. With clean distraction-free design and no clutter

Tonbun Tonbun is a desktop app for reading and downloading manga. With clean distraction-free design and no clutter. Build with Rust, Tauri, Vue.js, a

null 23 Nov 30, 2022