mirror of
https://github.com/gorhill/uBlock.git
synced 2024-11-07 03:12:33 +01:00
165 lines
8.9 KiB
Markdown
165 lines
8.9 KiB
Markdown
**Important note:** This is a fork of the [new official repo](https://github.com/chrisaljoudi/uBlock). Although both projects are essentially the same as of 0.9.3.0, they will probably start to diverge as time goes (update: they already [started to diverge](https://github.com/chrisaljoudi/uBlock/issues/1259) feature-wise).
|
||
|
||
I consider uBlock₀ here to be mature feature-wise.
|
||
|
||
To stop adding features at a fast pace does not make a software automatically obsolete. If you believe so, find out how many features were added to Adblock Plus in the last months. New features were added almost every week for months to uBlock.
|
||
|
||
I will keep maintaining the project here though so as to ensure it works just fine, i.e. bug fixing for the most part. Stability and reliability has priority at this point.
|
||
|
||
I may add features whenever I feel the need to do so -- I use the extension myself, so if I feel it definitely needs something more, I will just go ahead and add it.
|
||
|
||
The filter lists will continue to update themselves at regular interval, as usual.
|
||
|
||
To the recurring question: "Why did you handover the original project?", [answer is here](https://github.com/gorhill/uBlock/issues/38#issuecomment-91871802).
|
||
|
||
***
|
||
|
||
<h1 align="center">
|
||
<sub>
|
||
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/img/icon38@2x.png"
|
||
height="38"
|
||
width="38">
|
||
</sub>
|
||
uBlock Origin
|
||
</h1>
|
||
<p align="center">
|
||
<sup> <!-- Pronounciation -->
|
||
pronounced <i>you-block origin</i> (<code>/ˈjuːˌblɒk/</code>) — <i>you</i> decide what enters your browser.
|
||
</sup>
|
||
<br>
|
||
<sup> <!-- Languages -->
|
||
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/img/languageicon-36.png" width="18" height="18">
|
||
<sup>
|
||
English, <a href="https://github.com/fang5566/uBlock/blob/master/README.md#-µblock">
|
||
Chinese (中文), </a><a href="https://github.com/delightbot/uBlock/blob/master/README.md#ublock">
|
||
Korean (한국어) </a>
|
||
</sup>
|
||
</sup>
|
||
</p>
|
||
|
||
|
||
**An efficient blocker add-on for various browsers. Fast, potent, and lean.** [<img src="https://travis-ci.org/gorhill/uBlock.svg?branch=master" height="12">](https://travis-ci.org/gorhill/uBlock)
|
||
|
||
* [Purpose & General Info](#philosophy)
|
||
* [Documentation](#documentation)
|
||
* [Performance and Efficiency](#performance)
|
||
* [Memory](#memory)
|
||
* [CPU](#cpu)
|
||
* [Blocking](#blocking)
|
||
* [Quick tests](#quick-tests)
|
||
* [Installation](#installation)
|
||
* [Chromium](#chromium)
|
||
* [Firefox](#firefox)
|
||
* [Safari](#safari)
|
||
* [Release History](#release-history)
|
||
* [Wiki](https://github.com/gorhill/uBlock/wiki)
|
||
|
||
## Philosophy
|
||
|
||
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.
|
||
|
||
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.
|
||
|
||
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)).
|
||
|
||
_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.
|
||
|
||
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.
|
||
|
||
## 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>
|
||
|
||
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).
|
||
|
||
## Performance
|
||
|
||
#### Memory
|
||
|
||
<div align="center">
|
||
On average, uBlock₀ <b>really</b> does make your browser run leaner. <sup>[1]</sup><br><br>
|
||
|
||
Chromium <sup>[2]</sup><br>
|
||
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/mem-usage-overall-chart-20141224.png" /><br><br>
|
||
|
||
Firefox<br>
|
||
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/mem-usage-overall-chart-20150205.png" /><br><br>
|
||
|
||
</div>
|
||
|
||
<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>
|
||
|
||
<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>
|
||
|
||
#### CPU
|
||
|
||
<p align="center">
|
||
uBlock₀ is also easy on the CPU<br>
|
||
<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>
|
||
</p>
|
||
|
||
#### Blocking
|
||
|
||
<p align="center">
|
||
Being lean and efficient doesn't mean blocking less<br>
|
||
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/privex-201502-16.png" /><br>
|
||
<sup>For details of benchmark, see
|
||
<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>.
|
||
</p>
|
||
|
||
#### Quick tests
|
||
|
||
- [Index](http://raymondhill.net/ublock/tests.html)
|
||
- [Web page components](http://raymondhill.net/ublock/tiles1.html)
|
||
- [Popups](http://raymondhill.net/ublock/popup.html)
|
||
|
||
## Installation
|
||
|
||
Feel free to read [about the extension's required permissions](https://github.com/gorhill/uBlock/wiki/About-the-required-permissions).
|
||
|
||
#### Chromium
|
||
|
||
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/).
|
||
|
||
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.
|
||
|
||
#### 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.
|
||
|
||
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.
|
||
|
||
#### Safari
|
||
|
||
There is no support for Safari for uBlock Origin.
|
||
|
||
Best is that you install [chrisaljoudi/uBlock](https://github.com/chrisaljoudi/uBlock), which has official support for Safari.
|
||
|
||
#### Note for all browsers
|
||
|
||
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.
|
||
|
||
## Release History
|
||
|
||
See the [releases pages](https://github.com/gorhill/uBlock/releases) for a history of releases and highlights for each release.
|
||
|
||
## About
|
||
|
||
[uBlock Origin's manifesto](MANIFESTO.md).
|
||
|
||
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
|
||
all for free.
|
||
|
||
You can contribute by helping translate uBlock₀ [on Crowdin](https://crowdin.net/project/ublock).
|
||
|
||
## License
|
||
|
||
[GPLv3](https://github.com/gorhill/uBlock/blob/master/LICENSE.txt).
|