diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 29 |
1 files changed, 16 insertions, 13 deletions
diff --git a/README.md b/README.md index f22e0371..6424a2e5 100644 --- a/README.md +++ b/README.md @@ -1,48 +1,51 @@ <img src="./img/libredirect_full.svg" height="50"/> -A web extension that redirects YouTube, Twitter, TikTok... requests to alternative privacy friendly frontends and backends. +A browser extension that redirects YouTube, Twitter, TikTok... requests to alternative privacy friendly frontends and backends. -[](https://addons.mozilla.org/firefox/addon/libredirect/) +<a href="https://addons.mozilla.org/firefox/addon/libredirect/"> + <img src ="./img/badge-amo.png" height=60 > +</a> + <a href="https://libredirect.github.io/download_chromium.html"> -<img src ="./img/badge-chromium.png" height=60 > + <img src ="./img/badge-chromium.png" height=60 > </a> ## Translate - -[](https://hosted.weblate.org/projects/libredirect/extension) +<a href="https://hosted.weblate.org/projects/libredirect/extension"> + <img src ="./img/weblate.svg"> +</a> ## Development -Requirements: [Node.js LTS](https://nodejs.org/) +Install [Node.js](https://nodejs.org/) ```bash git clone https://github.com/libredirect/browser_extension cd browser_extension npm install -npm run html # Generates html files using Pug -npm run start # Runs in debug mode in firefox using Web-ext +npm run html # Generates html using Pug +npm run start # Runs in firefox in debug mode using Web-ext ``` -### Run on Chromium manually +### Build and Run on Chromium manually 1. Open `chrome://extensions` 2. Enable `dev mode` 3. Select `load unpacked extension` 4. Select `src` folder -### Build zip package (Firefox) +### Build a zip package for Firefox ```bash npm run build ``` -### Install zip package on Firefox (temporarily) +### Install the 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 zip package on Firefox ESR, Developer Edition, Nightly +### Install the 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 - --- Forked from [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect) |