uBlock/README.md

167 lines
8.8 KiB
Markdown
Raw Normal View History

2015-05-27 13:15:51 +02:00
[<img src="https://travis-ci.org/gorhill/uBlock.svg?branch=master" height="18">](https://travis-ci.org/gorhill/uBlock)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/ublock/localized.png)](https://crowdin.com/project/ublock)
***
2015-06-10 16:46:19 +02:00
There is an idea floating around that uBlock Origin is a _lesser_ branch relative to [uBlock](https://github.com/chrisaljoudi/uBlock)<sup>[1]</sup>.
2015-06-02 01:31:57 +02:00
2015-06-10 16:46:19 +02:00
The current reality is that there are *two branches*, not an official one and a lesser one. I keep developing my branch the same way and in the same spirit I have since [the beginning of uBlock in June 23, 2014](http://www.wilderssecurity.com/threads/ublock-a-lean-and-fast-blocker.365273/).
2015-06-02 01:31:57 +02:00
2015-06-10 16:54:04 +02:00
You are more likely than anywhere else to find a neutral explanation in this [Wikipedia article](http://en.wikipedia.org/wiki/UBlock) for the differences in features between uBlock Origin and uBlock.
2015-06-01 16:52:47 +02:00
2015-06-10 16:43:17 +02:00
<sub>[1] [An example](https://www.ublock.org/faq/). [Another one](https://addons.mozilla.org/en-US/firefox/addon/ublock-origin/reviews/716364/).</sub>
2015-05-26 17:03:03 +02:00
2015-04-04 13:34:38 +02:00
***
<h1 align="center">
<sub>
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/img/icon38@2x.png"
height="38"
width="38">
</sub>
2015-04-14 22:50:49 +02:00
uBlock Origin
</h1>
<p align="center">
2015-03-08 01:53:01 +01:00
<sup> <!-- Pronounciation -->
2015-04-07 22:32:01 +02:00
pronounced <i>you-block origin</i> (<code>/ˈjuːˌblɒk/</code>) — <i>you</i> decide what enters your browser.
2015-03-08 01:53:01 +01:00
</sup>
<br>
<sup> <!-- Languages -->
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/img/languageicon-36.png" width="18" height="18">
2015-03-08 01:35:47 +01:00
<sup>
English, <a href="https://github.com/fang5566/uBlock/blob/master/README.md#-µblock">
2015-03-12 07:08:57 +01:00
Chinese (中文), </a><a href="https://github.com/delightbot/uBlock/blob/master/README.md#ublock">
Korean (한국어) </a>
2015-03-08 01:35:47 +01:00
</sup>
</sup>
</p>
2015-05-27 13:15:51 +02:00
**An efficient blocker add-on for various browsers. Fast, potent, and lean.**
2014-06-23 02:00:34 +02:00
* [Purpose & General Info](#philosophy)
2015-03-27 21:21:31 +01:00
* [Documentation](#documentation)
* [Performance and Efficiency](#performance)
* [Memory](#memory)
* [CPU](#cpu)
* [Blocking](#blocking)
2015-02-01 20:52:01 +01:00
* [Quick tests](#quick-tests)
* [Installation](#installation)
2015-01-17 04:47:40 +01:00
* [Chromium](#chromium)
* [Firefox](#firefox)
2015-01-17 04:14:46 +01:00
* [Safari](#safari)
* [Release History](#release-history)
* [Wiki](https://github.com/gorhill/uBlock/wiki)
2014-06-23 02:00:34 +02:00
2015-01-17 04:43:37 +01:00
## Philosophy
2014-09-19 16:16:34 +02:00
2015-04-14 23:28:04 +02:00
uBlock Origin (or uBlock₀) is not an *ad blocker*; it's a general-purpose blocker. uBlock₀ blocks ads through its support of the [Adblock Plus filter syntax](https://adblockplus.org/en/filters). uBlock₀ [extends](https://github.com/gorhill/uBlock/wiki/Filter-syntax-extensions) the syntax and is designed to work with custom rules and filters.
2014-09-19 16:16:34 +02:00
That said, it's important to note that using a blocker is **NOT** [theft](https://twitter.com/LeaVerou/status/518154828166725632). Don't fall for this creepy idea. The _ultimate_ logical consequence of `blocking = theft` is the criminalisation of the inalienable right to privacy.
2014-09-19 16:16:34 +02:00
2015-04-07 02:25:50 +02:00
Ads, "unintrusive" or not, are just the visible portions of privacy-invading apparatus entering your browser when you visit most sites nowadays. **uBlock₀'s main goal is to help users neutralize such privacy-invading apparatus** — in a way that welcomes those users who don't wish to use more technical, involved means (such as [µMatrix](https://github.com/gorhill/uMatrix)).
2015-04-07 02:25:50 +02:00
_EasyList_, _Peter Lowe's Adservers_, _EasyPrivacy_ and _Malware domains_ are enabled by default when you install uBlock₀. Many more lists are readily available to block trackers, analytics, and more. Hosts files are also supported.
2015-04-07 02:25:50 +02:00
Once you install uBlock₀, you may easily un-select any of the pre-selected filter lists if you think uBlock₀ blocks too much. For reference, Adblock Plus installs with only _EasyList_ enabled by default.
2015-02-26 16:00:27 +01:00
2015-03-27 21:20:50 +01:00
## Documentation
[Quick guide: popup user interface](https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface)
<a href="https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface"><img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/img/popup-1.png" /></a>
2015-04-07 02:25:50 +02:00
For advanced usage, read about [dynamic filtering](https://github.com/gorhill/uBlock/wiki/Dynamic-filtering:-quick-guide) and more on [uBlock₀'s wiki](https://github.com/gorhill/uBlock/wiki).
2015-03-27 21:20:50 +01:00
2015-01-17 04:43:37 +01:00
## Performance
2015-01-17 04:43:37 +01:00
#### Memory
2014-08-24 22:30:48 +02:00
<div align="center">
2015-04-07 02:25:50 +02:00
On average, uBlock₀ <b>really</b> does make your browser run leaner. <sup>[1]</sup><br><br>
2015-02-06 15:04:39 +01:00
Chromium <sup>[2]</sup><br>
2015-02-06 15:00:44 +01:00
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/mem-usage-overall-chart-20141224.png" /><br><br>
Firefox<br>
2015-02-06 14:46:51 +01:00
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/mem-usage-overall-chart-20150205.png" /><br><br>
</div>
2014-06-23 02:00:34 +02:00
2015-02-06 15:04:39 +01:00
<sup>[1] Details of the benchmark available at <a href="https://github.com/gorhill/uBlock/wiki/Firefox-version:-benchmarking-memory-footprint">Firefox version: benchmarking memory footprint</a>.</sup><br>
2015-02-06 15:00:44 +01:00
2015-02-06 15:04:39 +01:00
<sup>[2] Important note: There is currently a [bug in Chromium 39+ which causes a new memory leak each time the popup UI of an extension is opened](https://code.google.com/p/chromium/issues/detail?id=441500). This affects <i>all</i> extensions. Keep this in mind when measuring Chromium's memory usage. In the benchmarks, I avoided opening the popups completely.</sup><br>
2015-02-06 15:00:44 +01:00
2015-01-17 04:43:37 +01:00
#### CPU
2014-12-27 18:30:50 +01:00
2014-06-26 18:48:32 +02:00
<p align="center">
2015-04-07 02:25:50 +02:00
uBlock₀ is also easy on the CPU<br>
2014-12-26 18:08:06 +01:00
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/cpu-usage-overall-chart-20141226.png" /><br>
<sup>Details of the benchmark available in <a href="https://github.com/gorhill/uBlock/blob/master/doc/benchmarks/cpu-usage-overall-20141226.ods">this LibreOffice spreadsheet</a>.</sup>
2014-07-05 22:57:37 +02:00
</p>
2014-06-24 17:10:13 +02:00
2015-01-17 04:43:37 +01:00
#### Blocking
2014-07-15 16:56:35 +02:00
<p align="center">
Being lean and efficient doesn't mean blocking less<br>
2015-02-16 20:52:27 +01:00
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/privex-201502-16.png" /><br>
<sup>For details of benchmark, see
2015-04-07 02:25:50 +02:00
<a href="https://github.com/gorhill/uBlock/wiki/uBlock-and-others%3A-Blocking-ads%2C-trackers%2C-malwares">uBlock₀ and others: Blocking ads, trackers, malwares</a>.
2014-07-15 16:56:35 +02:00
</p>
2015-02-01 21:06:40 +01:00
#### Quick tests
2015-02-01 20:52:01 +01:00
2015-02-01 21:06:40 +01:00
- [Index](http://raymondhill.net/ublock/tests.html)
2015-02-01 20:52:01 +01:00
- [Web page components](http://raymondhill.net/ublock/tiles1.html)
- [Popups](http://raymondhill.net/ublock/popup.html)
2015-05-30 00:40:33 +02:00
- [ABP Test Pages](https://testpages.adblockplus.org/)
2015-02-01 20:52:01 +01:00
2014-06-23 02:00:34 +02:00
## Installation
Feel free to read [about the extension's required permissions](https://github.com/gorhill/uBlock/wiki/About-the-required-permissions).
2015-01-17 04:47:40 +01:00
#### Chromium
2015-04-30 01:20:33 +02:00
You can install the latest version [manually](https://github.com/gorhill/uBlock/tree/master/dist#install), from the [Chrome Store](https://chrome.google.com/webstore/detail/ublock-origin/cjpalhdlnbpafiamejdnhcphjbkeiagm), or from the [Opera store](https://addons.opera.com/en-gb/extensions/details/ublock/).
2015-04-30 01:20:07 +02:00
Alternatively, you can install [chrisaljoudi/uBlock](https://github.com/chrisaljoudi/uBlock) from [Chrome store](https://chrome.google.com/webstore/detail/ublock/epcnnfbjfcgphgdmggkamkmgojdagdnn). Slightly different feature set, same performance.
2015-01-17 04:43:37 +01:00
#### Firefox
[Firefox Add-ons web site](https://addons.mozilla.org/firefox/addon/ublock-origin/), or install manually by downloading the latest [uBlock0.firefox.xpi](https://github.com/gorhill/uBlock/releases) file, and by dragging the downloaded `xpi` file to your add-on page.
2015-04-30 01:20:07 +02:00
Alternatively, you can install [chrisaljoudi/uBlock](https://github.com/chrisaljoudi/uBlock) from [Firefox Add-ons homepage](https://addons.mozilla.org/firefox/addon/ublock/). Slightly different feature set, same performance, proper support for legacy Firefox-based browsers.
2015-03-31 20:48:24 +02:00
2015-06-11 00:04:59 +02:00
For Firefox legacy versions -- prior to Firefox 29 -- it is best to install [chrisaljoudi/uBlock](https://github.com/chrisaljoudi/uBlock) as it has official support for legacy Firefox versions.
2015-06-11 00:04:12 +02:00
2015-01-17 04:43:37 +01:00
#### Safari
2015-04-25 16:56:52 +02:00
There is no support for Safari for uBlock Origin.
2015-04-21 13:57:55 +02:00
Best is that you install [chrisaljoudi/uBlock](https://github.com/chrisaljoudi/uBlock), which has official support for Safari.
2015-03-05 03:05:36 +01:00
2015-01-17 04:43:37 +01:00
#### Note for all browsers
2014-06-23 02:00:34 +02:00
2015-04-25 16:56:52 +02:00
To benefit from uBlock Origin's higher efficiency, it's advised that you don't use other inefficient blockers at the same time (such as AdBlock or Adblock Plus). uBlock₀ will do [as well or better](#blocking) than most popular ad blockers.
2014-06-24 06:38:26 +02:00
## Release History
See the [releases pages](https://github.com/gorhill/uBlock/releases) for a history of releases and highlights for each release.
2014-07-30 00:07:36 +02:00
2014-06-23 02:00:34 +02:00
## About
2015-04-25 16:56:52 +02:00
[uBlock Origin's manifesto](MANIFESTO.md).
2014-08-26 00:51:39 +02:00
Free. Open source. For users by users. No donations sought.
Without the preset lists of filters, this extension is nothing. So if ever you
really do want to contribute something, think about the people working hard
to maintain the filter lists you are using, which were made available to use by
2014-06-26 22:33:36 +02:00
all for free.
2015-04-07 02:25:50 +02:00
You can contribute by helping translate uBlock₀ [on Crowdin](https://crowdin.net/project/ublock).
2014-07-05 22:03:59 +02:00
2014-06-23 02:00:34 +02:00
## License
2014-06-24 07:55:32 +02:00
[GPLv3](https://github.com/gorhill/uBlock/blob/master/LICENSE.txt).