Merge branch 'update_readme' into 'develop'

Update readme

See merge request tom79/nitterizeme!142
This commit is contained in:
Thomas 2021-10-26 17:50:42 +00:00
commit b149c557eb
7 changed files with 45 additions and 17 deletions

View File

@ -1,42 +1,70 @@
# UntrackMe [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Crowdin](https://badges.crowdin.net/nitterizeme/localized.svg)](https://crowdin.com/project/nitterizeme) [![pipeline status](https://framagit.org/tom79/nitterizeme/badges/develop/pipeline.svg)](https://framagit.org/tom79/nitterizeme/commits/develop) # UntrackMe [![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Crowdin](https://badges.crowdin.net/nitterizeme/localized.svg)](https://crowdin.com/project/nitterizeme) [![pipeline status](https://framagit.org/tom79/nitterizeme/badges/develop/pipeline.svg)](https://framagit.org/tom79/nitterizeme/commits/develop)
UntrackMe once set by default to open Twitter and YouTube links will transform them into Nitter and Invidious links and delegate the action to another app. UntrackMe transforms Twitter, YouTube, Instagram, Reddit and Medium and Wikipedia links to links of open source, [privacy friendly front-ends](#privacy-friendly-front-ends). Converts Google Maps links to OpenStreetMap links. Removes tracking parameters from any url. Then delegates the action to other apps that are capable of handling them.
There are two versions of UntrackMe - Once handling all URLs for removing tracking parameters - Another one called "UntrackMe Lite" that will only handle Twitter, Youtube, Instagram, Google Maps and shortened URLs. ##### Versions of UntrackMe:
- **Lite**<br>
Can handle Twitter, YouTube, Instagram, Reddit Medium, Wikipedia, Google Maps and shortened urls.
- **Full**<br>
All features of _Lite_ version + Can remove tracking parameters from any url.
## Donate ## Donate
[<img alt="Donate using Liberapay" src="http://img.shields.io/liberapay/patrons/tom79.svg?logo=liberapay"/>](https://liberapay.com/tom79/donate) [<img alt="Donate using Liberapay" src="http://img.shields.io/liberapay/patrons/tom79.svg?logo=liberapay"/>](https://liberapay.com/tom79/donate)
## Download ## Download
Full version: [<img alt='Get it on F-Droid' src='./images/get-it-on-fdroid.png' height="80"/>](https://f-droid.org/app/app.fedilab.nitterizeme) - **Full Version**:<br>
[<img alt='Get it on F-Droid' src='./images/get-it-on-fdroid.png' height="80"/>](https://f-droid.org/app/app.fedilab.nitterizeme)
Lite version: [<img alt='Get it on F-Droid' src='./images/get-it-on-fdroid.png' height="80"/>](https://f-droid.org/app/app.fedilab.nitterizemelite) - **Lite Version**:<br>
[<img alt='Get it on F-Droid' src='./images/get-it-on-fdroid.png' height="80"/>](https://f-droid.org/app/app.fedilab.nitterizemelite)
### What is Nitter: ## Privacy Friendly Front-Ends
A free and open source alternative Twitter front-end focused on privacy. - **Nitter**<br>
Github project: [/zedeus/nitter](https://github.com/zedeus/nitter) Nitter is a free and open source front-end for Twitter<br>
_Source Code: [github.com/zedeus/nitter](https://github.com/zedeus/nitter)_
- **Invidious**<br>
Invidious is a free and open source front-end for YouTube<br>
_Source Code: [github.com/iv-org/invidious](https://github.com/iv-org/invidious)_
### What is Invidious: - **Bibliogram**<br>
Bibliogram is a free and open source front-end for Instagram<br>
_Source Code: [sr.ht/~cadence/bibliogram](https://sr.ht/~cadence/bibliogram)_
A free and open source alternative front-end to YouTube - **Teddit**<br>
Github project: [/omarroth/invidious](https://github.com/omarroth/invidious) Teddit is a free and open source front-end for Reddit<br>
_Source Code: [codeberg.org/teddit/teddit](https://codeberg.org/teddit/teddit)_
### What is Bibliogram: - **Libreddit**<br>
Libreddit is a free and open source front-end for Reddit<br>
_Source Code: [github.com/spikecodes/libreddit](https://github.com/spikecodes/libreddit)_
- **Scribe**<br>
Scribe is a free and open source front-end for Medium<br>
_Source Code: [sr.ht/~edwardloveall/scribe](https://sr.ht/~edwardloveall/scribe)_
- **Wikiless**<br>
Wikiless is a free and open source front-end for Wikipedia<br>
_Source Code: [codeberg.org/orenom/wikiless](https://codeberg.org/orenom/wikiless)_
A free and open source alternative front-end to Instagram
Github project: [/cloudrac3r/bibliogram](https://github.com/cloudrac3r/bibliogram)
### Screenshots: ### Screenshots:
<img alt="A simple interface to cusomize instances" src="src/fullLinks/fastlane/metadata/android/en-US/images/phoneScreenshots/1.png" width=250/>
![A simple interface to cusomize instances](./images/img1.png) ![Clicking on app will open settings](./images/img2.png) ![You can get latencies for instances and pick up them here](./images/img3.png) <img alt="The app handled and transformed it before delegating the action" src="src/fullLinks/fastlane/metadata/android/en-US/images/phoneScreenshots/2.png" width=250/>
![A YouTube link received via a text message](./images/img4.png) ![The app handled and transformed it before delegating the action](./images/img5.png) ![The app opened the transformed link](./images/img6.png) <img alt="You can get latencies for instances and pick up them here" src="src/fullLinks/fastlane/metadata/android/en-US/images/phoneScreenshots/4.png" width=250/>
<img alt="You can customize the parameters and values you want to add to invidious urls" src="src/fullLinks/fastlane/metadata/android/en-US/images/phoneScreenshots/5.png" width=250/>
<img alt="Check which domains are set to open in UntrackMe" src="src/fullLinks/fastlane/metadata/android/en-US/images/phoneScreenshots/6.png" width=250/>
### Going further ### Going further
@ -44,7 +72,7 @@ Github project: [/cloudrac3r/bibliogram](https://github.com/cloudrac3r/bibliogra
#### Invidition #### Invidition
For a full coverage with URLs, you can use FireFox with the [Invidition](https://addons.mozilla.org/fr/firefox/addon/invidition/) plugin from [@booteille](https://framapiaf.org/@booteille). For a full coverage with URLs, you can use FireFox with the [Invidition](https://addons.mozilla.org/fr/firefox/addon/invidition/) plugin from [@booteille](https://framapiaf.org/@booteille).
Source code of [Invidition on Godeberg](https://codeberg.org/Booteille/invidition) Source code of [Invidition on Codeberg](https://codeberg.org/Booteille/invidition)
#### Privacy Redirect #### Privacy Redirect

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 66 KiB