Skip to content

Repository files navigation

ReadAble

ReadAble is a Manifest V3 Chrome extension that adds accessible reading tools to web pages: OpenDyslexic font, high contrast, font scaling, spacing controls, scoped application modes, and reading aids.

Development

Install dependencies:

npm install

Run checks:

npm run lint
npm run build

Load the extension locally:

  1. Run npm run build.
  2. Open chrome://extensions.
  3. Enable Developer mode.
  4. Click Load unpacked.
  5. Select the dist directory.

Rise-style font regression fixture

After loading the unpacked extension, run:

npm run test:rise

Enable OpenDyslexic for the opened local page, then click Run checks. The fixture recreates the competing .fr-view font rule inside an iframe and checks lesson paragraphs, table text, code, and editable controls.

Packaging

Create the Chrome Web Store zip:

npm run package

The package script builds dist, removes unused font sources/formats and local metadata, then writes dist.zip.

Chrome Web Store Updates

When code, manifest, or packaged assets change, upload a new zip in the Chrome Web Store Developer Dashboard. The manifest version must be higher than the currently published version.

This extension currently uses the activeTab, scripting, and storage permissions. Adding new permissions later can change the user-facing permission prompt during updates.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages