about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 27 insertions, 6 deletions
diff --git a/README.md b/README.md
index 0161dfe0..b9a330da 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
 <img src="src/assets/images/libredirect.svg" width="150" align="right" />
-  
+
 # LibRedirect
 A web extension that redirects YouTube, Twitter, Instagram... requests to alternative privacy friendly frontends and backends.
 
@@ -18,8 +18,8 @@ Medium => [Scribe](https://sr.ht/~edwardloveall/scribe/)
 **Note**: It will default to using random instances if none are selected. You can also set custom instances.
 
 [![Matrix Badge](https://badges.alefvanoon.xyz/matrix/libredirect:matrix.org?label=Matrix)](https://matrix.to/#/#libredirect:tokhmi.xyz)
-[![PrivacyPolicy](https://badges.alefvanoon.xyz/badge/-PrivacyPolicy-orange
-)](Privacy-Policy.md)
+[![PrivacyPolicy](https://badges.alefvanoon.xyz/badge/-PrivacyPolicy-orange)](Privacy-Policy.md)
+
 ## Get
 [![Firefox Add-on](src/assets/images/badge-amo.png)](https://addons.mozilla.org/firefox/addon/libredirect/)
 
@@ -28,15 +28,36 @@ Medium => [Scribe](https://sr.ht/~edwardloveall/scribe/)
 
 ## Development
 ### Install Dependencies
-- [Node.js](https://nodejs.org/) >=10.0.0 installed
+- [Node.js](https://nodejs.org/) latest LTS is recommended
+- `npm update`
 - `npm install`
 
 ### Build
 - `npm run build`
-- `open web-ext-artifacts/`
 
 ### Test
 - `npm run test`
 
+### Test in Firefox
+- `npm run-script start`
+
+### Install temporarily
+- open `about:addons`
+- click on the settings button below the addon search bar and select `debug add-on`
+- press `load temporarily addon`
+
+### Install in Firefox ESR (Extended Support Release), Developer Edition and Nightly
+- open `about:config`
+- set `xpinstall.signatures.required` to `false`
+- open `about:addons`
+- click on the settings button below the addon search bar and select install add-on from file
+- select libredirect-VERSION.zip from 'web-ext-artifacts' folder
+
+### Install in Chromium, Brave and Chrome
+- open `chrome://extensions`
+- enable `dev mode`
+- select `load unpacked extension`
+- select `src` folder
+
 ## Credits
-- [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect)
\ No newline at end of file
+- [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect)