search

ansh / jiffyreader.com

A Browser Extension for faster reading on ANY website!
https://www.jiffyreader.com/
GNU General Public License v3.0
3.72k stars 198 forks source link
bookmark brave-extension browser-extension chrome-extension firefox-extension opera-extension read-faster reader reading safari-extension web-extension

readme

====================================================================================

THIS PROJECT IS NO LONGER MAINTAINED. THIS REPOSITORY IS AN ARCHIVE FOR EDUCATIONAL PURPOSES ONLY.

====================================================================================

Jiffy Reader

A Browser Extension for Faster Reading on ANY website!

Jiffy Reader - Read anything on the internet faster and more clearly | Product Hunt

Jiffy Reader - Read anything on the internet faster and more clearly! | Product Hunt

Buy Me A Coffee

How it works

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? Screenshot from 2022-05-29 19-13-02

The best way to install this extension is to follow the instructions below.

Table of Contents

Installation Instructions

Chrome

Download via Chrome Store or follow the instructions below

  1. Click here to download the latest jiffyReader-chrome.zip release
  2. Extract the file
  3. Open Chrome
  4. Enter chrome://extensions in the address bar
  5. Enable developer mode with the toggle on the top right side of the page if it is not enabled already
  6. Click load unpacked on the left side of the page
  7. Find and select the extracted folder, this extension should now be installed
  8. To pin the extension, click the puzzle icon on the top right of Chrome, then pin the extension.
  9. The extensions default reading mode is set to off when installed
  10. 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.

Firefox

Download via the Mozilla Firefox Plugin/Add-on Store or follow the instructions below

  1. Download jiffyReader-firefox.xpi by right clicking here and choose Save link as to download the latest jiffyReader-firefox.xpirelease
  2. Open Firefox
  3. Enter about:debugging#/runtime/this-firefox in the address bar
  4. Click Load Temporary Add-on... and navigate to the path of the downloaded jiffyReader-firefox.xpi and select it to install it
  5. The extensions default reading mode is set to off when installed
  6. 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.

Safari

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

  1. We will be converting the web extension for Safari usage. This will require a macOS computer and the latest version of XCode installed.
  2. Use git clone to clone the Jiffy Reader repo locally.
  3. Run pnpm build:xcode or pnpm build:xcode:all to convert the extension.
  4. Open the Safari app on your Mac and make sure to click Develop -> Allow Unsigned Extensions in the top menu bar.
  5. Open the project in XCode and click run!

Firefox Nightly / Fennec F-droid / Mull (Android)

  1. Go to settings
  2. Scroll to the bottom and select About {browser name}
  3. Tap the browser logo five times
  4. Go back to settings and in the Advanced section, select Custom Add-on collection
  5. Type 17432789 as the collection owner (user ID)
  6. Type jiffyreader as the collection name. The browser will close to apply the settings.
  7. 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.

Opera

  1. Download: Click here to download the latest jiffyReader-opera.crx release
  2. Extract the file
  3. Open Opera
  4. Enter opera://extensions in the address bar
  5. Enable developer mode with the toggle on the top right side of the page if it is not enabled already
  6. Click load unpacked on the left side of the page
  7. Find and select the extracted folder, this extension should now be installed and listed on the screen
  8. To pin the extension, click the cube icon on the top right of Chrome, then pin the extension.
  9. The extensions default reading mode is set to off when installed
  10. See the faq section on how to use the extension, customize it (global and per site settings) and excluding sites from always on

Edge

Android (kiwi Browser)

  1. Download the kiwi browser if you do not already have it installed
  2. Open kiwi browser
  3. Navigate to the extension listing on Chrome Store and
  4. Click the Add to Chrome button to install the extension
  5. The extensions default reading mode is set to off when installed
  6. See the faq section on how to use the extension, customize it (global and per site settings) and excluding sites from always on

Bookmarklet

(Note: Bookmarklet is not in active support and may break when new updates are released)

  1. To install the bookmarklet, head over to this link

First Installation Welcome

FAQ

How to access the extension settings/popup ui

Desktop

  1. Click on the (on chrome: puzzle icon | on edge puzzle icon | on opera cube icon | on brave puzzle icon)
    • Note: Firefox will auto pin the extension
  2. Click on the pin icon next to jiffy reader to pin it next the address bar
  3. Click on the pinned icon to access the settings/popup menu

Android (kiwi browser)

  1. Click on the more (3 vertical dots) button and scroll down
  2. Click on Jiffy Reader to open the settings/popup ui

What are the functions of the buttons and sliders

Global preferences button

Site preferences button

Enable reading mode button

Saccades interval slider

Fixation strength slider

Fixation edge opacity

Saccades colors

Saccades styles

Line height buttons

Always on/off button

Reset Defaults

PDF and Epub support

Google Play Books Native (Epub)

Upload Epubs to Google PlayBooks (Epubs)

PFD Support (convert pdf files to epub or html)

  1. Open cloud convert to
  2. Upload your pdf file
  3. Select your output format (html or epub)
  4. Click convert to start the process
  5. Click download
  6. Open your downloaded html file in your browser and turn on JiffyReader

Google Docs support (publish method)

  1. Open the google docs document in your browser
  2. Click File > click share > click publish to web
  3. Click publish and copy the published link. Alternatively you can replace edit in the address bar with pub to access the published document
  4. Open the published link in a new tab and turn on JiffyReader

Google Docs support (html download method)

  1. Click on File > click download
  2. Download the document as an html (preferred) or epub optional Google Play Books Native (Epub)
  3. Open the downloaded html with your browser and turn on JiffyReader
    • You may be required to enable permissions to access file urls for chrome. To do so follow Enable file permissions

Enable file url permissions (chrome html)

  1. (Chrome) Enable JiffyReader to work with tabs that have file urls by right clicking on the JiffyReader icon
  2. Click manage extension
  3. Find and enable work with file urls

Customizations

Shortcut

What is Faster Reading?

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.

Reporting Issues, bugs and feature request

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

How to Contribute

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.

Help with Translations

JiffyReader is in need of translation help for what ever language you can. To help:

  1. 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.
  2. Open a issue ticket and add the translation label to it along with the name of the language you want to translate. Use this shortcut link to open a new ticket
  3. 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.

  4. 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.

    Working with the translation files.

    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"
}

    Submitting your translations

    • 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.

    Supported languages

  5. English: by JiffyReader maintainer
  6. Spanish: by JiffyReader maintainer

  7. 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.

Development

  1. Clone the project
  2. Open in VS Code or your favorite editor
  3. Run yarn or npm i to install dependencies
  4. Install pnpm if you don't already have it, use npm i -g pnpm
  5. Run pnpm dev:chrome or pnpm run dev:chrome to build the development version. Substitute chrome for firefox if that is your preferred browser.
  6. Follow the installation version for your preferred browser but navigate to the projectRootFolder/build/ and choose the folder that corresponds with your browser.

Configure vscode to run the project when it is opened

  1. Copy .vscode/tasks.json.example to .vscode/tasks.json or enter cp .vscode/tasks.json.example .vscode/tasks.json in the terminal from the project root
  2. Open vs code command pallet
  3. Type and select Tasks: Manage Automatic Tasks in Folder
  4. Click Allow Automatic Tasks in Folder.
  5. Reload VS code.

Release a new version