diff --git a/README.md b/README.md index 4e27f59..a3ae03a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # HTTP Switchboard for Chromium -See [Change log](https://github.com/gorhill/httpswitchboard/wiki/Change-log) for latest changes. +**Important:** No longer developed. Project has been split into two distinct, more advanced extensions: [uBlock Origin](https://github.com/gorhill/uBlock) and [uMatrix](https://github.com/gorhill/uMatrix). -A Chromium browser extension which let you white- or blacklist requests +*** + +See [releases](https://github.com/gorhill/httpswitchboard/releases) for latest changes. + +A Chromium browser extension which let you whitelist or blacklist requests originating from within a web page according to their type and/or destination -as per domain name. As of December 2013, the extension comes with preset -blacklists totaling over 45,000 distinct hostnames (these lists can be disabled, -and more can be enabled). +as per domain name. As of May 2014, the extension comes with preset blacklists +totaling over 60,000 distinct hostnames out of the box (these lists can be +disabled, or more can be enabled). + +A overview made by a fan: (Thanks!) ## Installation @@ -15,15 +21,17 @@ Available from [Chrome web store](https://chrome.google.com/webstore/detail/http or you can [install manually](https://github.com/gorhill/httpswitchboard/tree/master/dist). **I strongly advise against installing from any other sources.** -I expect the extension to work on any Chromium-based browser. +I expect the extension to work on a stable release of any Chromium-based browser. + +[**IMPORTANT:** Compatibility with various Chromium based browsers and other extensions](https://github.com/gorhill/httpswitchboard/wiki/Compatibility-with-various-Chromium-based-browsers-and-other-extensions) ## The matrix: front end to the matrix filtering engine

- +
- Click for more details + Click for more details

## The filtering engine @@ -35,35 +43,51 @@ I expect the extension to work on any Chromium-based browser. Click for more details

+Much effort has been spent on creating **highly efficient filtering engines**: +HTTPSB can hold tens of thousands more filtering rules in memory while having a +significantly smaller memory and CPU footprint than other comparable popular +blockers. + +In the picture below, HTTPSB was running with over 115K filters, **tens +of thousands more** than other blockers. After running this +[reference benchmark](https://github.com/gorhill/httpswitchboard/wiki/Comparative-benchmarks-against-widely-used-blockers:-Top-15-Most-Popular-News-Websites), +the memory footprints: + +

+ +**Adblock Plus:** EasyList, EasyPrivacy. **Adblock:** EasyList, EasyPrivacy, Malware protection. **Adguard:** English filter, Spyware & tracking filter, Phishing & malware protection. **HTTPSB:** 65,935 malware, ads, trackers, etc hostname-based filters, 25,206 ABP-compatible net filters, 24,184 ABP-compatible cosmetic filters. Garbage collection was forced for all blockers using Chromium dev tools. + ## Documentation [More at the wiki](https://github.com/gorhill/httpswitchboard/wiki) HTTP Switchboard (FOSS) put you in FULL control of where your browser is allowed to connect, what type of data it is allowed to download, and what it is allowed to execute. Nobody else decides for you: You choose. You are in full control of your privacy. -* See ALL the remote connections, failed or attempted, depending on whether they were blocked or allowed (you decide). +- See ALL the remote connections, failed or attempted, depending on whether they were blocked or allowed (you decide). -* A single-click to whitelist/blacklist one or multiple classes of requests according to the destination and type of data (a blocked request will NEVER leave your browser). +- A single-click to whitelist/blacklist one or multiple classes of requests according to the destination and type +of data (a blocked request will NEVER leave your browser). -* Efficient blacklisting: cookies won't leave your browser, javascript won't execute, plugins won't play, tracking pixels won't download, etc. +- Efficient blacklisting: cookies won't leave your browser, javascript won't execute, plugins won't play, +tracking pixels won't download, etc. -* You do not have to solely rely on just one particular curated blacklist (arguably with many missing entries) outside which nothing else can be blocked. +- You do not have to solely rely on just one particular curated blacklist (arguably with many missing entries) outside which nothing else can be blocked. -* Ease of use: HTTP Switchboard lets you easily whitelist/blacklist net requests which originate from within a web page according to a point-and-click matrix: +- Ease of use: HTTP Switchboard lets you easily whitelist/blacklist net requests which originate from within a web page according to a point-and-click matrix: -- domain names (left column) - * from very specific - * to very generic +* domain names (left column) + - from very specific + - to very generic -- type of requests (top row) - * cookies - * css (stylesheets and web fonts) - * images - * objects - * scripts - * XHR (requests made by scripts) - * frames - * others +* type of requests (top row) + - cookies + - css (stylesheets and web fonts) + - images + - objects + - scripts + - XHR (requests made by scripts) + - frames + - others (`