Updated README.md
This commit is contained in:
nobody
parent
2a7ea82c87
commit
cde7cd6bbd
40
README.md
40
README.md
|
|
@ -1,7 +1,6 @@
|
|||
LocalCDN (forked from Decentraleyes)
|
||||
=============
|
||||
# LocalCDN
|
||||
A web browser extension that emulates Content Delivery Networks to improve your online privacy. It intercepts traffic, finds supported resources locally, and injects them into the environment. All of this happens automatically, so no prior configuration is required. Feel free to use the following [testing utility](https://localcdn.de/test/) to find out if you are properly protected. For more information, please read this [basic introduction from Decentraleyes](https://git.synz.io/Synzvato/decentraleyes/wikis/Simple-Introduction) or our [Wiki pages](https://codeberg.org/nobody/LocalCDN/wiki).
|
||||
|
||||
A web browser extension that emulates Content Delivery Networks to improve your online privacy. It intercepts traffic, finds supported resources locally, and injects them into the environment. All of this happens automatically, so no prior configuration is required. Feel free to use the following [testing utility](https://localcdn.de/test/) to find out if you are properly protected. For more information, please read this [basic introduction from Decentraleyes](https://git.synz.io/Synzvato/decentraleyes/wikis/Simple-Introduction) or our [Wiki pages](https://gitlab.com/nobody42/localcdn/-/wikis/home).
|
||||
|
||||
## Differences between LocalCDN and Decentraleyes
|
||||
|
||||
|
|
@ -17,9 +16,10 @@ LocalCDN based on Decentraleyes. It includes more frameworks and more CDNs:
|
|||
|
||||
> **Note:** LocalCDN is no silver bullet, but it does prevent a lot of websites from making you send these kinds of requests. Ultimately, you can make LocalCDN block requests for any missing CDN resources, too.
|
||||
|
||||
|
||||
## What is the different of LocalCDN in comparison to other CDN emulators?
|
||||
|
||||
<img src="/screenshots/replacement.png?raw=true" alt="The Replacement of Libraries">
|
||||
<img src="https://localcdn.de/img/replacement.png" alt="The Replacement of Libraries">
|
||||
|
||||
**Advantages of LocalCDN:**
|
||||
|
||||
|
|
@ -31,49 +31,43 @@ LocalCDN based on Decentraleyes. It includes more frameworks and more CDNs:
|
|||
|
||||
:thumbsup: doesn't matter which version a website requested
|
||||
|
||||
|
||||
## We need you!
|
||||
|
||||
|
||||
|
||||
|
||||
The whole Internet is full of different frameworks and CDNs that negatively affect your privacy. If you find a website that embeds another unsupported version of a framework, please report that website.
|
||||
|
||||
|
||||
### :warning: **Important** :warning:
|
||||
|
||||
In some cases, it isn't possible to use our framework because the website sets up a strong "Same Origin Policy" (SOP). Please read [Broken JavaScript or CSS on some websites](https://gitlab.com/nobody42/localcdn/-/wikis/faq/Broken-JavaScript-or-CSS-on-some-websites) before opening an issue.
|
||||
In some cases, it isn't possible to use our framework because the website sets up a strong "Same Origin Policy" (SOP). Please read [Broken JavaScript or CSS on some websites](https://codeberg.org/nobody/LocalCDN/wiki/Broken-JavaScript-or-CSS-on-some-websites) before opening an issue.
|
||||
|
||||
On behalf of everyone: Thank you!
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Light
|
||||
<img src="/screenshots/screenshot01_light.png?raw=true" alt="Counter for locally injected resources (enabled)" width="200px">
|
||||
<img src="/screenshots/screenshot02_light.png?raw=true" alt="Counter for locally injected resources (disabled)" width="200px">
|
||||
<img src="/screenshots/screenshot03_light.png?raw=true" alt="Successfully intercepted requests" width="200px">
|
||||
<img src="/screenshots/screenshot04_light.png?raw=true" alt="Successfully intercepted requests" width="200px">
|
||||
[](https://localcdn.de/img/screenshots/screenshot01_light.png) [](https://localcdn.de/img/screenshots/screenshot02_light.png) [](https://localcdn.de/img/screenshots/screenshot03_light.png) [](https://localcdn.de/img/screenshots/screenshot04_light.png)
|
||||
|
||||
### Dark
|
||||
<img src="/screenshots/screenshot01_dark.png?raw=true" alt="Counter for locally injected resources (enabled)" width="200px">
|
||||
<img src="/screenshots/screenshot02_dark.png?raw=true" alt="Counter for locally injected resources (disabled)" width="200px">
|
||||
<img src="/screenshots/screenshot03_dark.png?raw=true" alt="Successfully intercepted requests" width="200px">
|
||||
<img src="/screenshots/screenshot04_dark.png?raw=true" alt="Successfully intercepted requests" width="200px">
|
||||
[](https://localcdn.de/img/screenshots/screenshot01_dark.png) [](https://localcdn.de/img/screenshots/screenshot02_dark.png) [](https://localcdn.de/img/screenshots/screenshot03_dark.png) [](https://localcdn.de/img/screenshots/screenshot04_dark.png)
|
||||
|
||||
### Rule generator for uBlock/uMatrix
|
||||
<img src="/screenshots/screenshot06.png?raw=true" alt="Release notes and uBlock/uMatrix rule generator" width="200px">
|
||||
<img src="/screenshots/screenshot07.png?raw=true" alt="Release notes and uBlock/uMatrix rule generator" width="200px">
|
||||
<img src="/screenshots/screenshot08.png?raw=true" alt="Preferences page and uBlock/uMatrix rule generator" width="200px">
|
||||
<img src="/screenshots/screenshot09.png?raw=true" alt="Preferences page and uBlock/uMatrix rule generator" width="200px">
|
||||
[](https://localcdn.de/img/screenshots/screenshot06.png) [](https://localcdn.de/img/screenshots/screenshot07.png) [](https://localcdn.de/img/screenshots/screenshot08.png) [](https://localcdn.de/img/screenshots/screenshot09.png)
|
||||
|
||||
|
||||
## Contributing Code
|
||||
|
||||
Suggestions in the form of **Issues**, and contributions in the form of **Merge Requests**, are highly welcome.
|
||||
|
||||
#### Installation
|
||||
## Installation
|
||||
|
||||
* Mozilla Firefox *(63 or higher)*: [get it on addons.mozilla.org](https://addons.mozilla.org/en-US/firefox/addon/localcdn-fork-of-decentraleyes/)
|
||||
* Chromium based browser: [Chrome Web Store (by Emanuel Bennici :+1:)](https://chrome.google.com/webstore/detail/localcdn-fork-from-decent/njdfdhgcmkocbgbhcioffdbicglldapd)
|
||||
* Chromium based browser: [Chrome Web Store (by Emanuel Bennici)](https://chrome.google.com/webstore/detail/localcdn-fork-from-decent/njdfdhgcmkocbgbhcioffdbicglldapd)
|
||||
|
||||
#### Running the Code
|
||||
#### Running the Code as temporary extension
|
||||
|
||||
Please read this [developer guide](https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Your_first_WebExtension#Trying_it_out) for information on how to run the extension from source.
|
||||
|
||||
|
|
@ -86,9 +80,7 @@ Just open an issue with your question or write an [email](https://localcdn.de/co
|
|||
|
||||
## Donations
|
||||
|
||||
LocalCDN is free, open-source and based on Decentraleyes. If you like LocalCDN and/or Decentraleyes you can support continued development by making a donation. Any help would be greatly appreciated!
|
||||
* [Donate to LocalCDN](https://localcdn.de/donate/)
|
||||
* [Donate to Decentraleyes](https://decentraleyes.org/donate)
|
||||
LocalCDN is free and open-source. If you like LocalCDN you can support continued development by making a donation. Any help would be greatly appreciated! Every way to donate can be found on the [website](https://localcdn.de/donate/). At the moment donations are possible with SEPA bank transfer.
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue