diff options
| -rw-r--r-- | README.md | 61 | ||||
| -rw-r--r-- | package.json | 5 |
2 files changed, 25 insertions, 41 deletions
diff --git a/README.md b/README.md index df721a7c..e597053c 100644 --- a/README.md +++ b/README.md @@ -12,53 +12,36 @@ A web extension that redirects YouTube, Twitter, TikTok... requests to alternati [](https://hosted.weblate.org/projects/libredirect/extension) ## Development - -### Install Dependencies - -[Node.js](https://nodejs.org/) latest LTS is recommended - -``` -npm update +Requirements: [Node.js LTS](https://nodejs.org/) +```bash +git clone https://github.com/libredirect/browser_extension +cd browser_extension npm install +npm run html +npm run start # Runs on firefox using web-ext ``` +### Run on Chromium manually +1. Open `chrome://extensions` +2. Enable `dev mode` +3. Select `load unpacked extension` +4. Select `src` folder -Generate the HTML pages (you should install [pug-cli](https://www.npmjs.com/package/pug-cli) first globally): - -``` -npm run pug -``` - -### Build the extension zip archive: - -``` +### Build zip package (Firefox) +```bash npm run build ``` - -### Test in Firefox - -``` -npm run start -``` - -### Install temporarily - -1. Type in the address bar: `about:debugging#/runtime/this-firefox` -3. Press `Load Temporary Add-on...` - -### Install in Firefox ESR, Developer Edition, Nightly - -1. Type in the address bar: `about:config` -2. Set `xpinstall.signatures.required` to `false` -3. Type in the address bar: `about:addons` -4. Click on the gear shaped `settings` button and select `Install Add-on From File...` +### Install zip package on Firefox (temporarily) +3. Type in the address bar: `about:debugging#/runtime/this-firefox` +4. Press `Load Temporary Add-on...` 5. Select `libredirect-VERSION.zip` from `web-ext-artifacts` folder -### Install in Chromium browsers +### Install zip package on Firefox ESR, Developer Edition, Nightly +3. Type in the address bar: `about:config` +4. Set `xpinstall.signatures.required` to `false` +5. Type in the address bar: `about:addons` +6. Click on the gear shaped `settings` button and select `Install Add-on From File...` +7. Select `libredirect-VERSION.zip` from `web-ext-artifacts` folder -1. Open `chrome://extensions` -2. Enable `dev mode` -3. Select `load unpacked extension` -4. Select `src` folder --- diff --git a/package.json b/package.json index 5afbf163..76eb63eb 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ "start_ar": "web-ext run --firefox=/home/esmail/Downloads/ar/firefox/firefox --pref font.language.group=ar", "build": "web-ext build", "test": "web-ext lint", - "pug": "pug --pretty --basedir ./ --obj ./src/config.json src/pages/options/index.pug --out src/pages/options/ && pug --pretty --basedir ./ --obj ./src/config.json src/pages/popup/popup.pug --out src/pages/popup/" + "html": "pug --basedir ./ --obj ./src/config.json src/pages/options/index.pug --out src/pages/options/ && pug --basedir ./ --obj ./src/config.json src/pages/popup/popup.pug --out src/pages/popup/" }, "repository": { "type": "git", @@ -23,7 +23,8 @@ }, "homepage": "https://libredirect.github.io", "devDependencies": { - "web-ext": "^7.2.0" + "web-ext": "^7.2.0", + "pug-cli": "^1.0.0-alpha6" }, "webExt": { "sourceDir": "./src/", |