Skip to content
This repository was archived by the owner on Jul 16, 2025. It is now read-only.

Commit f3e446e

Browse files
Merge pull request #338 from asieduernest12/ZiqiangWangUNSW-master
@ZiqiangWangUNSW Update some urls in the README.md
2 parents 47e63ac + 7534aa7 commit f3e446e

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

README.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,11 @@ The best way to install this extension is to follow the instructions below.
5959
- [Reset Defaults](#reset-defaults)
6060
- [PDF and Epub support](#pdf-and-epub-support)
6161
- [Google Play Books Native (Epub)](#google-play-books-native-epub)
62-
- [Upload Epubs to Google PlayBooks (Epubs)](#upload-epubs-to-google-playbooks-epubs)
62+
- [Upload Epubs to Google Play Books (Epubs)](#upload-epubs-to-google-play-books-epubs)
6363
- [PFD Support (convert pdf files to epub or html)](#pfd-support-convert-pdf-files-to-epub-or-html)
6464
- [Google Docs support (publish method)](#google-docs-support-publish-method)
6565
- [Google Docs support (html download method)](#google-docs-support-html-download-method)
66-
- [Enable file url permissions (chrome html)](#enable-file-url-permissions-chrome-html)
66+
- [Enable file url permissions (Chrome)](#enable-file-url-permissions-chrome)
6767
- [Customizations](#customizations)
6868
- [Shortcut](#shortcut)
6969
- [What is Faster Reading?](#what-is-faster-reading)
@@ -77,14 +77,14 @@ The best way to install this extension is to follow the instructions below.
7777
- [Configure vscode to run the project when it is opened](#configure-vscode-to-run-the-project-when-it-is-opened)
7878
- [Release a new version](#release-a-new-version)
7979

80-
# Installation Instructions
80+
# Installation Instructions
8181

8282

8383
## Chrome
8484

8585
> Download via [Chrome Store](https://chrome.google.com/webstore/detail/jiffy-reader/lljedihjnnjjefafchaljkhbpfhfkdic) or follow the instructions below
8686
87-
1. Click [here](https://github.com/ansh/jiffyreader.com/releases/latest/download/jiffyReader-chrome.zip) to download the latest `jiffyReader-chrome.zip` release
87+
1. Click [here](https://github.com/ansh/jiffyreader.com/releases/latest/download/jiffyReader-chrome-prod.zip) to download the latest `jiffyReader-chrome-prod.zip` release
8888
2. Extract the file
8989
3. Open Chrome
9090
4. Enter `chrome://extensions` in the address bar
@@ -93,20 +93,20 @@ The best way to install this extension is to follow the instructions below.
9393
7. Find and select the extracted folder, this extension should now be installed
9494
8. To pin the extension, click the `puzzle icon` on the top right of Chrome, then `pin the extension`.
9595
9. The extensions default reading mode is set to off when installed
96-
10. See the [faq section](#FAQ) on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
96+
10. See the [FAQ](#FAQ) section on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
9797

9898
The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/about-mellowtel), an open-source library to support the development of free browser extensions.
9999

100100
## Firefox
101101

102102
> Download via the [Mozilla Firefox Plugin/Add-on Store](https://addons.mozilla.org/en-US/firefox/addon/jiffy-reader/) or follow the instructions below
103103
104-
1. Download `jiffyReader-firefox.xpi` by right clicking [here](https://github.com/ansh/jiffyreader.com/releases/latest/download/jiffyReader-firefox.xpi) and choose `Save link as` to download the latest `jiffyReader-firefox.xpi `release
104+
1. Download `jiffyReader-firefox-prod.xpi` by right-clicking [here](https://github.com/ansh/jiffyreader.com/releases/latest/download/jiffyReader-firefox-prod.xpi) and choose `Save link as` to download the latest `jiffyReader-firefox-prod.xpi `release
105105
2. Open Firefox
106106
3. Enter `about:debugging#/runtime/this-firefox` in the address bar
107-
4. Click `Load Temporary Add-on...` and navigate to the path of the downloaded `jiffyReader-firefox.xpi` and select it to install it
107+
4. Click `Load Temporary Add-on...` and navigate to the path of the downloaded `jiffyReader-firefox-prod.xpi` and select it to install it
108108
5. The extensions default reading mode is set to off when installed
109-
6. See the [faq section](#FAQ) on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
109+
6. See the [FAQ](#FAQ) section on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
110110

111111
<strong>Firefox will remove the extension when the browser is closed if the extension is not downloaded from the store.</strong>
112112

@@ -134,7 +134,7 @@ The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/ab
134134

135135
## Opera
136136

137-
1. Download: Click [here](https://github.com/ansh/jiffyreader.com/releases/latest/download/jiffyReader-opera.crx) to download the latest `jiffyReader-opera.crx` release
137+
1. Download: Click [here](https://github.com/ansh/jiffyreader.com/releases/latest/download/jiffyReader-opera-prod.crx) to download the latest `jiffyReader-opera-prod.crx` release
138138
2. Extract the file
139139
3. Open Opera
140140
4. Enter `opera://extensions` in the address bar
@@ -143,7 +143,7 @@ The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/ab
143143
7. Find and select the extracted folder, this extension should now be installed and listed on the screen
144144
8. To pin the extension, click the `cube icon` on the top right of Chrome, then `pin the extension`.
145145
9. The extensions default reading mode is set to off when installed
146-
10. See the [faq section](#FAQ) on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
146+
10. See the [FAQ](#FAQ) section on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
147147

148148
## Edge
149149

@@ -155,7 +155,7 @@ The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/ab
155155
3. Navigate to the extension listing on [Chrome Store](https://chrome.google.com/webstore/detail/jiffy-reader/lljedihjnnjjefafchaljkhbpfhfkdic) and
156156
4. Click the `Add to Chrome` button to install the extension
157157
5. The extensions default reading mode is set to off when installed
158-
6. See the [faq section](#FAQ) on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
158+
6. See the [FAQ](#FAQ) section on how to use the extension, customize it (global and per site settings) and excluding sites from `always on`
159159

160160
## Bookmarklet
161161

@@ -202,7 +202,7 @@ The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/ab
202202

203203
#### Enable reading mode button
204204
- Click this button to turn on/off the emphasis (bionification) of the text on the page.
205-
- Press `ALT + B` on chrome and `ALT + W` on firefox to achieve the same effect as clicking this button on chrome. see the [shortcut-section](#shortcut) for more info.
205+
- Press `ALT + B` on chrome and `ALT + W` on firefox to achieve the same effect as clicking this button on chrome. see the [shortcut](#shortcut) section for more info.
206206

207207
#### Saccades interval slider
208208
- Use this slider to set how many words are left untouched/unbolded or un-emphasized after the first emphasized word or the first word.
@@ -234,14 +234,14 @@ The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/ab
234234
## PDF and Epub support
235235

236236
### Google Play Books Native (Epub)
237-
- This extension works with [google play books](https://play.google.com/books)
238-
1. Open or navigate to [google play books](https://play.google.com/books)
237+
- This extension works with [Google Play Books](https://play.google.com/books)
238+
1. Open or navigate to [Google Play Books](https://play.google.com/books)
239239
2. Click on any book in your library to read it and turn on the extension if not on already
240240
3. You can search for new books (paid or free) and add to your library to start reading
241241

242-
#### Upload Epubs to Google PlayBooks (Epubs)
243-
- Upload your Epub ebooks to Google Play Books reads to be able to read it with JiffyReader.
244-
1. Open [google play books](https://play.google.com/books)
242+
#### Upload Epubs to Google Play Books (Epubs)
243+
- Upload your Epub ebook(s) to Google Play Books, then you will be able to read it with JiffyReader.
244+
1. Open [Google Play Books](https://play.google.com/books)
245245
2. Click the upload button
246246
3. Select your epub file to complete the upload
247247
4. Click on the uploaded file to open it in the Google Play Books web reader. Have fun.
@@ -256,34 +256,34 @@ The Chrome version includes support for [mellowtel.dev](https://mellowtel.dev/ab
256256

257257

258258
- For chrome permission issues, follow the steps in [Enable file url permissions (Chrome)](#enable-file-url-permissions-chrome)
259-
- For epub files follow the steps in [Upload Epub to Google PlayBooks](#upload-epubs-to-google-playbooks-epubs)
259+
- For epub files follow the steps in [Upload Epub to Google Play Books](#upload-epubs-to-google-play-books-epubs)
260260
- JiffyReader does not collaborate with cloudconvert. Please consult their privacy policy for any privacy concerns.
261261

262262
### Google Docs support (publish method)
263-
1. Open the google docs document in your browser
263+
1. Open the Google Docs document in your browser
264264
2. Click File > click share > click publish to web
265265
3. Click publish and copy the published link. Alternatively you can replace `edit` in the address bar with `pub` to access the published document
266266
4. Open the published link in a new tab and turn on JiffyReader
267267

268268
- Note: the document will be accessible to anyone on the internet as long as they have the correct link.
269-
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)](#google-docs-support-download-method)
269+
If you do not want to publish the document to the web then please follow the alternative steps in [Google Docs support (html download method)](#google-docs-support-html-download-method)
270270

271-
### Google Docs support (html download method)
271+
### Google Docs support (html download method)
272272
1. Click on File > click download
273-
2. Download the document as an html (preferred) or epub optional [Google Play Books Native (Epub)](#google-play-books-native-epub-and-pdf-support)
273+
2. Download the document as a html (preferred) or epub optional [Google Play Books Native (Epub)](#google-play-books-native-epub)
274274
3. Open the downloaded html with your browser and turn on JiffyReader
275275
- 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)
276276

277-
### Enable file url permissions (chrome html)
278-
1. (Chrome) Enable JiffyReader to work with tabs that have file urls by right clicking on the JiffyReader icon
277+
### Enable file url permissions (Chrome)
278+
1. Enable JiffyReader to work with tabs that have file urls by right-clicking on the JiffyReader icon
279279
2. Click manage extension
280-
3. Find and enable work with file urls
280+
3. Find `Allow access to file URLs` option and enable it
281281

282282

283283
# Customizations
284284

285285
## Shortcut
286-
- `Alt+B` is the default toggle shortcut to turn `on or off` the extension
286+
- `Alt+B` (on Windows) or `option+B` (on Mac) is the default toggle shortcut to turn `on or off` the extension
287287
- If preferred you may customize the extension shortcut with the help of the resources below
288288
- [Chrome, Firefox and Edge](https://www.makeuseof.com/open-browser-extensions-keyboard-shortcut/)
289289
- Opera: open the extension management tab and click the `Keyboard shortcuts` link to access the page for customizing opera shortcuts
@@ -297,8 +297,8 @@ As a result, the reader is only focusing on the bolded initial letters and lets
297297

298298
# Reporting Issues, bugs and feature request
299299
Visit the [issues page](https://github.com/ansh/jiffyreader.com/issues) to report, bugs or tell us about a feature you would like to see and hopefully we will get to you.
300-
Kindly allow for some time after submitting a issue for someone to get back to you.
301-
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-contribution)
300+
Kindly allow for some time after submitting an issue for someone to get back to you.
301+
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 [How to Contribute](#how-to-contribute) section.
302302

303303

304304

@@ -309,8 +309,8 @@ As a result, the reader is only focusing on the bolded initial letters and lets
309309
JiffyReader is in need of translation help for what ever language you can.
310310
To help:
311311
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.
312-
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](https://github.com/ansh/jiffyreader.com/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D+Give+a+suitable+title)
313-
3. Copy either the english locale json [click here](https://github.com/asieduernest12/jiffyreader.com/blob/7ab4cfb06b5e29be8b9cd8e1eb1a9c77aff10ef3/assets/_locales/en/messages.json) or spanish local json [click here](https://github.com/asieduernest12/jiffyreader.com/blob/7ab4cfb06b5e29be8b9cd8e1eb1a9c77aff10ef3/assets/_locales/es/messages.json) translate into the language you can assist with using your preferred editor or even ms word.
312+
2. Open an 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](https://github.com/ansh/jiffyreader.com/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=%5BFEATURE%5D+Give+a+suitable+title)
313+
3. Copy either the english locale json [click here](https://github.com/ansh/jiffyreader.com/blob/master/assets/_locales/en/messages.json) or spanish local json [click here](https://github.com/ansh/jiffyreader.com/blob/master/assets/_locales/es/messages.json) translate into the language you can assist with using your preferred editor or even Microsoft Word.
314314
4. Indicate the language you would like to help translate in the ticket title. This helps to eliminate duplicate work.
315315

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

0 commit comments

Comments
 (0)