====================================================================================
THIS PROJECT IS NO LONGER MAINTAINED. THIS REPOSITORY IS AN ARCHIVE FOR EDUCATIONAL PURPOSES ONLY.
====================================================================================
A Browser Extension for Faster Reading on ANY website!
Below is a screenshot demonstrating how the extension works by bolding out the initial parts of all text on any page when clicked. There are toggles and sliders to customize it to your preference so you can enjoy your time reading. You must agree this is awesome right?
The best way to install this extension is to follow the instructions below.
- Jiffy Reader
- How it works
- Table of Contents
- Installation Instructions
- First Installation Welcome
- FAQ
- Customizations
- What is Faster Reading?
- Reporting Issues, bugs and feature request
- How to Contribute
- Help with Translations
- Supported languages
Download via Chrome Store or follow the instructions below
- Click here to download the latest
jiffyReader-chrome.ziprelease - Extract the file
- Open Chrome
- Enter
chrome://extensionsin the address bar - Enable
developer modewith the toggle on the top right side of the page if it is not enabled already - Click
load unpackedon the left side of the page - Find and select the extracted folder, this extension should now be installed
- To pin the extension, click the
puzzle iconon the top right of Chrome, thenpin the extension. - The extensions default reading mode is set to off when installed
- See the faq section on how to use the extension, customize it (global and per site settings) and excluding sites from
always on
The Chrome version includes support for mellowtel.dev, an open-source library to support the development of free browser extensions.
Download via the Mozilla Firefox Plugin/Add-on Store or follow the instructions below
- Download
jiffyReader-firefox.xpiby right clicking here and chooseSave link asto download the latestjiffyReader-firefox.xpirelease - Open Firefox
- Enter
about:debugging#/runtime/this-firefoxin the address bar - Click
Load Temporary Add-on...and navigate to the path of the downloadedjiffyReader-firefox.xpiand select it to install it - The extensions default reading mode is set to off when installed
- See the faq section on how to use the extension, customize it (global and per site settings) and excluding sites from
always on
Firefox will remove the extension when the browser is closed if the extension is not downloaded from the store.
Download via the App Store here or TestFlight here. This works for both macOS and iOS. We are working on getting it approved to download directly via the App Store. If you want to build the app yourself, follow the instructions below
- We will be converting the web extension for Safari usage. This will require a macOS computer and the latest version of XCode installed.
- Use
git cloneto clone the Jiffy Reader repo locally. - Run
pnpm build:xcodeorpnpm build:xcode:allto convert the extension. - Open the Safari app on your Mac and make sure to click
Develop->Allow Unsigned Extensionsin the top menu bar. - Open the project in XCode and click run!
- Go to settings
- Scroll to the bottom and select
About {browser name} - Tap the browser logo five times
- Go back to settings and in the Advanced section, select
Custom Add-on collection - Type
17432789as the collection owner (user ID) - Type
jiffyreaderas the collection name. The browser will close to apply the settings. - Go to Add-ons/Add-ons manager to install the add-on.
For convenience you may want to enable the extension by default by clicking on the Turn On Always button in the add-on's menu.
- Download: Click here to download the latest
jiffyReader-opera.crxrelease - Extract the file
- Open Opera
- Enter
opera://extensionsin the address bar - Enable
developer modewith the toggle on the top right side of the page if it is not enabled already - Click
load unpackedon the left side of the page - Find and select the extracted folder, this extension should now be installed and listed on the screen
- To pin the extension, click the
cube iconon the top right of Chrome, thenpin the extension. - The extensions default reading mode is set to off when installed
- See the faq section on how to use the extension, customize it (global and per site settings) and excluding sites from
always on
- Please follow the steps for chrome above
- Download the kiwi browser if you do not already have it installed
- Open kiwi browser
- Navigate to the extension listing on Chrome Store and
- Click the
Add to Chromebutton to install the extension - The extensions default reading mode is set to off when installed
- See the faq section on how to use the extension, customize it (global and per site settings) and excluding sites from
always on
(Note: Bookmarklet is not in active support and may break when new updates are released)
- To install the bookmarklet, head over to this link
- Thank you for installing JiffyReader.
- Read the 8 points below which will help you the most in getting you started with JiffyReader
- Why did the browser open this page? because this is the first time you installed JiffyReader.
- The extension is on the default settings and optimal for most websites.
- Changes to settings are saved instantly and can be restored to the default optimal settings by clicking the
Reset Settingsbutton at the bottom of the extension. - If confused on how to use the buttons and sliders check out the section on what are the functions of the buttons and sliders.
- You can find important resources such as the FAQ section, how to contribute and how to report issues on this page.
- You can always get to this page by clicking the FAQ link in the footer of the extension popup.
- For further help, check the table of contents or open an issue ticket using the links at the very top of this page.
- You can close this page and return at anytime to find more help or clarification.
- Click on the (on chrome:
puzzle icon| on edgepuzzle icon| on operacube icon| on bravepuzzle icon)- Note: Firefox will auto pin the extension
- Click on the pin icon next to jiffy reader to pin it next the address bar
- Click on the pinned icon to access the settings/popup menu
- Click on the
more (3 vertical dots)button and scroll down - Click on
Jiffy Readerto open the settings/popup ui
- clicking this button enters global mode where your preferences are saved and applied to all other sites when you open them afterwards
- Clicking this buttons activates and saves preferences only for the site you are presently on.
- Any changes you make with the other buttons and sliders persist for only this site.
- Click this button to turn on/off the emphasis (bionification) of the text on the page.
- Press
ALT + Bon chrome andALT + Won firefox to achieve the same effect as clicking this button on chrome. see the shortcut-section for more info.
- Use this slider to set how many words are left untouched/unbolded or un-emphasized after the first emphasized word or the first word.
- 0 means there will not be a single or any untouched words, all words are emphasized.
- 1 means exactly 1 word is left untouched before the next successive emphasized word.
- 2 means 2 words are left untouched so does 3 and 4.
- Use this to control how much or how little of each word is emphasized you your liking .
- Use this to control how faint(weakly visible) or strongly visible you want the edge(un-emphasized) part of words to appear.
- Use this to select a means of creating emphasis using colors.
- Use this to select a means of creating emphasis using bold variations or underline variations.
- Use these buttons to increase or decrease line height to strain and improve the comfort of reading.
- Use this button to controls the default behavior which is if words on pages are or aren't emphasized when loaded by default.
- Resets preferences of the currently engaged preference mode.
- This extension works with google play books
- Open or navigate to google play books
- Click on any book in your library to read it and turn on the extension if not on already
- You can search for new books (paid or free) and add to your library to start reading
- Upload your Epub ebooks to Google Play Books reads to be able to read it with JiffyReader.
- Open google play books
- Click the upload button
- Select your epub file to complete the upload
- Click on the uploaded file to open it in the Google Play Books web reader. Have fun.
- Open cloud convert to
- Upload your pdf file
- Select your output format (html or epub)
- Click convert to start the process
- Click download
- Open your downloaded html file in your browser and turn on JiffyReader
- For chrome permission issues, follow the steps in Enable file url permissions (Chrome)
- For epub files follow the steps in Upload Epub to Google PlayBooks
- JiffyReader does not collaborate with cloudconvert. Please consult their privacy policy for any privacy concerns.
- Open the google docs document in your browser
- Click File > click share > click publish to web
- Click publish and copy the published link. Alternatively you can replace
editin the address bar withpubto access the published document - Open the published link in a new tab and turn on JiffyReader
- Note: the document will be accessible to anyone on the internet as long as they have the correct link. If you want do not want to publish the document to the web then please follow the alternative steps in Google Docs support (download method)
- Click on File > click download
- Download the document as an html (preferred) or epub optional Google Play Books Native (Epub)
- Open the downloaded html with your browser and turn on JiffyReader
- You may be required to enable permissions to access
file urlsfor chrome. To do so follow Enable file permissions
- (Chrome) Enable JiffyReader to work with tabs that have file urls by right clicking on the JiffyReader icon
- Click manage extension
- Find and enable work with file urls
Alt+Bis the default toggle shortcut to turnon or offthe extension- If preferred you may customize the extension shortcut with the help of the resources below
- Chrome, Firefox and Edge
- Opera: open the extension management tab and click the
Keyboard shortcutslink to access the page for customizing opera shortcuts
This extension provides faster reading through facilitating the reading process by bolding half the words. As a result, the reader is only focusing on the bolded initial letters and lets the brain autocomplete the words. This allows you to read faster.
Visit the issues page to report, bugs or tell us about a feature you would like to see and hopefully we will get to you. Kindly allow for some time after submitting a issue for someone to get back to you. You can also see a list of open issues that you may contribute to by commenting to help out someone with a challenge or developing and opening a PR. See contribution section
Anyone is welcome to provide contributions to this project by submitting a PR (Pull Request) and it will be happily merged to provide features and fixes to the incredible people using the extension.
JiffyReader is in need of translation help for what ever language you can. To help:
- Please check that the language you would like to help with has not already been taken up by someone else by looking through both the open and closed tickets for translations.
- Open a issue ticket and add the
translationlabel to it along with the name of the language you want to translate. Use this shortcut link to open a new ticket - Copy either the english locale json click here or spanish local json click here translate into the language you can assist with using your preferred editor or even ms word.
- Indicate the language you would like to help translate in the ticket title. This helps to eliminate duplicate work.
- Attach any questions or updates to the ticket you are working on and someone will try and get to them within a day or two.
The translation files are json formats. You only need to worry about translating the text associated with the message key.
<!-- example -->
"exampleText":{
"message": "this is the text to translate",
"description": "it is not required to translate this text"
}
```
- result after translation into spanish
```
"exampleText":{
"message": "esto es el texto a traducir",
"description": "it is not required to translate this text"
}
- You can email the translated file or paste the entire translation as a new comment in the ticket you opened and we will take it from there.
- Don't forget to indicate your name for attribution.
- English: by JiffyReader maintainer
- Spanish: by JiffyReader maintainer
- Others coming soon: contributor name
JiffyReader has been updated to support displaying information in multiple languages thanks to a strong interest and constant emails and enquiries about it. We have implemented the required mechanisms to support displaying the extension in the language of your choice. The challenge we have now is to get as many translations as possible.
- Clone the project
- Open in VS Code or your favorite editor
- Run
yarnornpm ito install dependencies - Install pnpm if you don't already have it, use
npm i -g pnpm - Run
pnpm dev:chromeorpnpm run dev:chrometo build the development version. Substitute chrome for firefox if that is your preferred browser. - Follow the installation version for your preferred browser but navigate to the
projectRootFolder/build/and choose the folder that corresponds with your browser.
- Copy
.vscode/tasks.json.exampleto.vscode/tasks.jsonor entercp .vscode/tasks.json.example .vscode/tasks.jsonin the terminal from theproject root - Open
vs code command pallet - Type and select
Tasks: Manage Automatic Tasks in Folder - Click
Allow Automatic Tasks in Folder. - Reload VS code.