diff --git a/README.md b/README.md index 1e68deb..590b445 100644 --- a/README.md +++ b/README.md @@ -4,29 +4,24 @@ **ClearURLs** is an add-on based on the new WebExtensions technology and is optimized for *Firefox* and *Chrome* based browsers. -This add-on will remove the tracking fields from all URLs, which are visited by the browser, with the help of an external rule file, -which is regularly updated by us and can be found [here](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.min.json), -to protect your privacy. +This extension will automatically remove tracking elements from URLs to help protect your privacy when browse through the Internet, +which is regularly updated by us and can be found [here](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/data/data.min.json). ## Application -Large (and small) websites use elements in the URL, e.g.: `https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale` -to track your online activities. In this example, the `utm` fields used to track a custom campaign, managed by Google. It tells the provider, and also Google, -the source, the medium (e.g. email or web) and the specific campaign of the link. All these tracking fields are not necessary for a website to be displayed -or work correctly and can therefore be removed - that is exactly what ClearURLs does, so you can think of it as an *URL clean maid*. +Many websites use tracking elements in the URL (e.g. `https://example.com?utm_source=newsletter1&utm_medium=email&utm_campaign=sale`) to mark your online activity. +All that tracking code is not necessary for a website to be displayed or work correctly and can therefore be removed—that is exactly what ClearURLs does. -Another common example are Amazon URLs. If you search for a product on Amazon you will get a very long URL for this product, e.g. -``` -https://www.amazon.com/dp/exampleProduct/ref=sxin_0_pb?__mk_de_DE=ÅMÅŽÕÑ&keywords=tea -&pd_rd_i=exampleProduct&pd_rd_r=8d39e4cd-1e4f-43db-b6e7-72e969a84aa5&pd_rd_w=1pcKM -&pd_rd_wg=hYrNl&pf_rd_p=50bbfd25-5ef7-41a2-68d6-74d854b30e30 -&pf_rd_r=0GMWD0YYKA7XFGX55ADP&qid=1517757263&rnid=2914120011 -``` -, -the most of this URL is available for tracking and is not needed. After ClearURLs has cleaned this URL, it looks like this: +Another common example are Amazon URLs. If you search for a product on Amazon you will see a very long URL, such as: +`https://www.amazon.com/dp/exampleProduct/ref=sxin_0_pb?__mk_de_DE=ÅMÅŽÕÑ&keywords=tea&pd_rd_i=exampleProduct&pd_rd_r=8d39e4cd-1e4f-43db-b6e7-72e969a84aa5&pd_rd_w=1pcKM&pd_rd_wg=hYrNl&pf_rd_p=50bbfd25-5ef7-41a2-68d6-74d854b30e30&pf_rd_r=0GMWD0YYKA7XFGX55ADP&qid=1517757263&rnid=2914120011` + +Indeed most of the above URL is tracking code. Once ClearURLs has cleaned the address, it will look like this: `https://www.amazon.com/dp/exampleProduct` +## Permissons +Reasoning for needed permissions can be found under [here](https://gitlab.com/KevinRoebert/ClearUrls/issues/159). + ## Screenshot -![Interface (version 1.8.5)](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/promotion/screens/Popup_1.8.5.png) +![Interface (version 1.11.0)](https://gitlab.com/KevinRoebert/ClearUrls/raw/master/promotion/screens/Popup_v_1.11.0.png) ## CI/CD Artifacts Download (for Firefox- and Chrome-Dev only) Here you can download the packed files for the Firefox- and Chrome-Dev: @@ -64,6 +59,7 @@ Please push your translation into the folder `_locales/{country code}/messages.j ## Recommended by... * [ghacks-user.js](https://github.com/ghacksuserjs/ghacks-user.js/wiki/4.1-Extensions) * [Awesome Humane Tech List](https://github.com/humanetech-community/awesome-humane-tech#tracking) +* ClearURLs is part of Mozilla's recommended extensions program ## Permissions Reasoning for needed permissions you can find under [this discussion](https://gitlab.com/KevinRoebert/ClearUrls/issues/159). diff --git a/promotion/screens/Popup_v_1.11.0.png b/promotion/screens/Popup_v_1.11.0.png new file mode 100644 index 0000000..d0f4cd3 Binary files /dev/null and b/promotion/screens/Popup_v_1.11.0.png differ