diff options
| author | Teddy Wing | 2018-08-05 04:55:20 +0200 |
|---|---|---|
| committer | Teddy Wing | 2018-08-05 05:00:14 +0200 |
| commit | be56f2a0c670d367f4a46e1d5c57537d265d4acf (patch) | |
| tree | 5fdae067fdb882d7f062ee11b5ca40a8eb4554df /README.md | |
| parent | 34ac3ec06080de340f6454be10075ad8983ba9bc (diff) | |
| download | Legibility-be56f2a0c670d367f4a46e1d5c57537d265d4acf.tar.bz2 | |
README: Add installation instructions
Includes instructions for Chrome and Firefox. Firefox is a little more
involved. For now not bothering to sign the extension.
Also update `manifest.json` to give the extension an add-on ID. This is
required as it must be used as the directory name in the Firefox
`extensions/` profile folder.
Thanks to these resources for explaining how to install an unpacked
extension in Firefox:
- https://stackoverflow.com/questions/27155766/how-to-install-unpacked-extension-in-firefox-chrome/27158189#27158189
- https://developer.mozilla.org/en-US/docs/Archive/Add-ons/Setting_up_extension_development_environment#Firefox_extension_proxy_file
- https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Alternative_distribution_options/Sideloading_add-ons
- https://stackoverflow.com/questions/37728865/install-webextensions-on-firefox-from-the-command-line/37739112#37739112
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 21 insertions, 1 deletions
@@ -26,7 +26,27 @@ subdomains), and terminated by a `.css` extension. ## Install -This extension _must_ be installed as an unpacked extension. +This extension should be installed unpacked to allow you to freely add and +modify stylesheets in the `css/` directory. + + +### Chrome +Begin by cloning this repository. Open the Extensions page +(`chrome://extensions/`) and click the "Load unpacked" button. In the resulting +file browser, select the extension's directory. + + +### Firefox +This extension is unsigned. Refer to "What are my options if I want to install +unsigned extensions in Firefox?" in +https://wiki.mozilla.org/Add-ons/Extension_Signing#FAQ before attempting to +install it. + + cd '~/Library/Application Support/Firefox/Profiles/PROFILE_DIRECTORY/extensions' + git clone https://github.com/teddywing/Legibility.git 'com.teddywing@legibility' + +Relaunch Firefox and open the Add-ons page (`about:addons`). Click the "Enable" +button on Legibility's row. ## License |