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.md76
1 files changed, 32 insertions, 44 deletions
diff --git a/README.md b/README.md
index 52aedc27..12166fb4 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 <img src="./img/libredirect_full.svg" height="50"/>
 
-A web extension that redirects YouTube, Twitter, Instagram... requests to alternative privacy friendly frontends and backends.
+A web extension that redirects YouTube, Twitter, TikTok... requests to alternative privacy friendly frontends and backends.
 
 [![Matrix Badge](https://img.shields.io/matrix/libredirect:matrix.org?label=matrix%20chat)](https://matrix.to/#/#libredirect:matrix.org)
 [![Firefox users Badge](https://img.shields.io/amo/users/libredirect?label=Firefox%20users)](https://addons.mozilla.org/firefox/addon/libredirect/)
@@ -16,29 +16,26 @@ A web extension that redirects YouTube, Twitter, Instagram... requests to altern
 <img src ="./img/1.png" width=350>&nbsp;
 <img src ="./img/2.png" width=350>&nbsp;
 <img src ="./img/3.png" width=350>&nbsp;
-<img src ="./img/4.png" width=350>&nbsp;
-
-- Youtube => [Invidious](https://github.com/iv-org/invidious), [Piped](https://github.com/TeamPiped/Piped), [Piped-Material](https://github.com/mmjee/Piped-Material), [CloudTube](https://sr.ht/~cadence/tube/), [FreeTube](https://github.com/FreeTubeApp/FreeTube), [Yattee](https://github.com/yattee/yattee)
-- Youtube Music => [Beatbump](https://github.com/snuffyDev/Beatbump), [Hyperpipe](https://codeberg.org/Hyperpipe/Hyperpipe)
-- Twitter => [Nitter](https://github.com/zedeus/nitter)
-- Instagram => [Bibliogram](https://sr.ht/~cadence/bibliogram/)
-- TikTok => [ProxiTok](https://github.com/pablouser1/ProxiTok)
-- Reddit => [Libreddit](https://github.com/spikecodes/libreddit#instances), [Teddit](https://codeberg.org/teddit/teddit#instances)
-- Imgur => [Rimgo](https://codeberg.org/video-prize-ranch/rimgo)
-- Wikipedia => [Wikiless](https://codeberg.org/orenom/wikiless)
-- Medium => [Scribe](https://sr.ht/~edwardloveall/scribe/)
-- Quora => [Quetre](https://github.com/zyachel/quetre)
-- IMDb => [libremdb](https://github.com/zyachel/libremdb)
-- PeerTube => [SimpleerTube](https://git.sr.ht/~metalune/simpleweb_peertube)
-- LBRY/Odysee => [Librarian](https://codeberg.org/librarian/librarian), [LBRY Desktop](https://lbry.com/get)
-- Search => [SearXNG](https://github.com/searxng/searxng), [SearX](https://searx.github.io/searx/), [Whoogle](https://benbusby.com/projects/whoogle-search/), [LibreX](https://github.com/hnhx/librex/)
-- Translate => [SimplyTranslate](https://git.sr.ht/~metalune/simplytranslate_web), [LingvaTranslate](https://github.com/TheDavidDelta/lingva-translate), [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate)
-- Google Maps => [OpenStreetMap](https://www.openstreetmap.org/), [FacilMap](https://github.com/FacilMap/facilmap)
-- Send Files => [Send](https://gitlab.com/timvisee/send)
+
+- Youtube <span>&#8594;</span> [Invidious](https://github.com/iv-org/invidious), [Piped](https://github.com/TeamPiped/Piped), [Piped-Material](https://github.com/mmjee/Piped-Material), [CloudTube](https://sr.ht/~cadence/tube/), [FreeTube](https://github.com/FreeTubeApp/FreeTube), [Yattee](https://github.com/yattee/yattee)
+- Youtube Music <span>&#8594;</span> [Beatbump](https://github.com/snuffyDev/Beatbump), [Hyperpipe](https://codeberg.org/Hyperpipe/Hyperpipe)
+- Twitter <span>&#8594;</span> [Nitter](https://github.com/zedeus/nitter)
+- TikTok <span>&#8594;</span> [ProxiTok](https://github.com/pablouser1/ProxiTok)
+- Reddit <span>&#8594;</span> [Libreddit](https://github.com/spikecodes/libreddit#instances), [Teddit](https://codeberg.org/teddit/teddit#instances)
+- Imgur <span>&#8594;</span> [Rimgo](https://codeberg.org/video-prize-ranch/rimgo)
+- Reuters <span>&#8594;</span> [Neuters](https://github.com/HookedBehemoth/neuters)
+- Medium <span>&#8594;</span> [Scribe](https://sr.ht/~edwardloveall/Scribe/)
+- Quora <span>&#8594;</span> [Quetre](https://github.com/zyachel/quetre)
+- IMDb <span>&#8594;</span> [libremdb](https://github.com/zyachel/libremdb)
+- LBRY/Odysee <span>&#8594;</span> [Librarian](https://codeberg.org/librarian/librarian), [LBRY Desktop](https://lbry.com/get)
+- Search <span>&#8594;</span> [SearXNG](https://github.com/searxng/searxng), [SearX](https://searx.github.io/searx/), [Whoogle](https://benbusby.com/projects/whoogle-search/), [LibreX](https://github.com/hnhx/librex/)
+- Translate <span>&#8594;</span> [SimplyTranslate](https://git.sr.ht/~metalune/simplytranslate_web), [LingvaTranslate](https://github.com/TheDavidDelta/lingva-translate), [LibreTranslate](https://github.com/LibreTranslate/LibreTranslate)
+- Google Maps <span>&#8594;</span> [OpenStreetMap](https://www.openstreetmap.org/), [FacilMap](https://github.com/FacilMap/facilmap)
+- Send Files <span>&#8594;</span> [Send](https://gitlab.com/timvisee/send)
 
 **Note**: The Extension will be using random instances by default. You can modify this and add custom instances too.
 
-# Please read the [FAQ](https://libredirect.codeberg.page/faq.html) if you have any questions!
+# Please read the [FAQ](https://libredirect.github.io/faq.html) if you have any questions!
 
 ## Donate
 
@@ -49,7 +46,7 @@ A web extension that redirects YouTube, Twitter, Instagram... requests to altern
 
 - XMR: `4AM5CVfaGsnEXQQjZSzJvaWufe7pT86ubcZPr83fCjb2Hn3iwcForTWFy2Z3ugXcufUwHaGcucfPMFgPXBFSYGFvNrmV5XR`
 
-Note : We have removed our addresses for BTC and ETH. If you want to donate via Crypto use OpenCollective. We still have XMR as OpenCollective doesn't support it.
+Note : We have removed our addresses for BTC and ETH. If you want to donate via Crypto, please use OpenCollective. We still have XMR as OpenCollective doesn't support it.
 ## Mirror Repos
 
 [![Codeberg](https://raw.githubusercontent.com/ManeraKai/manerakai/main/icons/codeberg.svg)](https://codeberg.org/LibRedirect/libredirect)&nbsp;&nbsp;
@@ -70,26 +67,18 @@ npm update
 npm install
 ```
 
-To generate HTML that uses `config.json` (needed to develop/build the extension), run:
+Generate the HTML pages (you should install [pug-cli](https://www.npmjs.com/package/pug-cli) first globally):
 
 ```
-npm run ejs
+npm run pug
 ```
 
-Afterwards, you will need to run it if you modify `config.json` or any files ending with .ejs.
-
 ### Build the extension zip archive:
 
 ```
 npm run build
 ```
 
-### Run automated tests
-
-```
-npm run test
-```
-
 ### Test in Firefox
 
 ```
@@ -98,24 +87,23 @@ npm run start
 
 ### Install temporarily
 
-1. open `about:addons`
-2. type in the address bar `about:debugging`
-3. press `load temporarily addon`
+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. open `about:config`
-2. set `xpinstall.signatures.required` to `false`
-3. open `about:addons`
-4. click on the gear shaped `settings` button and select `Install Add-on From File...`
-5. select `libredirect-VERSION.zip` from `web-ext-artifacts` folder
+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...`
+5. Select `libredirect-VERSION.zip` from `web-ext-artifacts` folder
 
 ### Install in Chromium browsers
 
-1. open `chrome://extensions`
-2. enable `dev mode`
-3. select `load unpacked extension`
-4. select `src` folder
+1. Open `chrome://extensions`
+2. Enable `dev mode`
+3. Select `load unpacked extension`
+4. Select `src` folder
 
 ---