uBlock/README.md

111 lines
6.0 KiB
Markdown
Raw Normal View History

2015-01-13 17:03:24 -07:00
# <sub>![logo](https://raw.githubusercontent.com/gorhill/uBlock/master/src/img/browsericons/icon38.png)</sub> µBlock
2014-10-03 19:42:18 -06:00
2015-01-13 17:04:56 -07:00
**An efficient blocker add-on for various browsers. Fast, potent, and lean.**
2014-06-22 18:00:34 -06:00
* [Purpose & General Info](#philosophy)
* [Performance and Efficiency](#performance)
* [Memory](#memory)
* [CPU](#cpu)
* [Blocking](#blocking)
* [Installation](#installation)
2015-01-16 20:47:40 -07:00
* [Chromium](#chromium)
* [Firefox](#firefox)
2015-01-16 20:14:46 -07:00
* [Safari](#safari)
* [Release History](#release-history)
* [Wiki](https://github.com/gorhill/uBlock/wiki)
2014-06-22 18:00:34 -06:00
2015-01-15 09:59:08 -07:00
# ![Build](https://travis-ci.org/gorhill/uBlock.svg?branch=master)
2015-01-15 09:58:46 -07:00
2015-01-16 20:43:37 -07:00
## Philosophy
2014-09-19 08:16:34 -06:00
µBlock is not an *ad blocker*; it's a general-purpose blocker. µBlock blocks ads through its support of the [Adblock Plus filter syntax](https://adblockplus.org/en/filters). µBlock [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 08:16:34 -06: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 08:16:34 -06:00
Ads, "unintrusive" or not, are just the visible portions of privacy-invading apparatus entering your browser when you visit most sites nowadays. **µBlock'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_ are enabled by default when you install µBlock. Many more lists are readily available to block trackers, analytics, and more. Hosts files are also supported.
2015-01-16 20:43:37 -07:00
## Performance
2015-01-16 20:43:37 -07:00
#### Memory
2014-08-24 14:30:48 -06:00
2014-06-26 10:48:32 -06:00
<p align="center">
On average, µBlock <b>really</b> does make your browser run leaner<br>
2014-12-26 10:08:06 -07:00
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/mem-usage-overall-chart-20141224.png" /><br>
<sup>Details of the benchmark available in <a href="https://github.com/gorhill/uBlock/blob/master/doc/benchmarks/mem-usage-overall-20141224.ods">this LibreOffice spreadsheet</a>.</sup>
2014-07-15 08:56:35 -06:00
</p>
2014-06-22 18:00:34 -06:00
2015-01-20 17:35:25 -07:00
<sup>**Important note regarding memory usage:** 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 *all* extensions. Keep this in mind when measuring Chromium's memory usage. In the benchmarks, I avoided opening the popups completely.</sup>
2015-01-16 20:43:37 -07:00
#### CPU
2014-12-27 10:30:50 -07:00
2014-06-26 10:48:32 -06:00
<p align="center">
µBlock is also easy on the CPU<br>
2014-12-26 10:08:06 -07: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 14:57:37 -06:00
</p>
2014-06-24 09:10:13 -06:00
2015-01-16 20:43:37 -07:00
#### Blocking
2014-07-15 08:56:35 -06:00
<p align="center">
Being lean and efficient doesn't mean blocking less<br>
2014-10-09 07:24:04 -06:00
<img src="https://raw.githubusercontent.com/gorhill/uBlock/master/doc/benchmarks/privex-201409-30.png" /><br>
<sup>For details of benchmark, see
2014-07-15 09:01:54 -06:00
<a href="https://github.com/gorhill/uBlock/wiki/%C2%B5Block-and-others:-Blocking-ads,-trackers,-malwares">µBlock and others: Blocking ads, trackers, malwares</a>.
2014-07-15 08:56:35 -06:00
</p>
2014-06-22 18:00:34 -06:00
## Installation
Feel free to read [about the extension's required permissions](https://github.com/gorhill/uBlock/wiki/About-the-required-permissions).
2015-01-16 20:47:40 -07:00
#### Chromium
2015-01-16 20:14:46 -07:00
You can install the latest version [manually](https://github.com/gorhill/uBlock/tree/master/dist#install), from the [Chrome Web Store](https://chrome.google.com/webstore/detail/cjpalhdlnbpafiamejdnhcphjbkeiagm), or from the [Opera store](https://addons.opera.com/en-gb/extensions/details/ublock/).
2015-01-16 20:43:37 -07:00
#### Firefox
2015-01-16 20:14:46 -07:00
You can install by dragging the latest [uBlock.firefox.xpi](https://github.com/gorhill/uBlock/releases) file to your add-on page.
2015-01-16 20:43:37 -07:00
#### Safari
2015-01-23 15:22:12 -07:00
You can get µBlock for Safari (Yosemite's 8.0 or newer) from the [Safari Extension Gallery](https://extensions.apple.com/details/?id=net.gorhill.uBlock-96G4BAKDQ9).
2015-01-23 15:22:12 -07:00
<sup>There are currently no plans to support older Safari's. It's not recommended that you install µBlock on them (*do it at your own risk*).</sup>
2015-01-16 20:43:37 -07:00
#### Note for all browsers
2014-06-22 18:00:34 -06:00
To benefit from µBlock's higher efficiency, it's advised that you don't use other inefficient blockers at the same time (such as AdBlock or Adblock Plus). µBlock will do [as well or better](#blocking) than most popular ad blockers.
2014-06-23 22:38:26 -06: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-29 16:07:36 -06:00
2014-06-24 08:52:44 -06:00
## Documentation
µBlock's functionality is self-explanatory and intuitive for the most part. One thing to note after you get started is the big power button in µBlock's popup:
2014-06-24 08:52:44 -06:00
2015-01-10 14:35:15 -07:00
![Popup](https://raw.githubusercontent.com/gorhill/uBlock/master/doc/img/popup-1.png)
2014-06-24 08:52:44 -06:00
The big power button is to disable/enable µBlock for the specific current site/hostname (as extracted from the URL of the current page).
2015-01-10 14:37:04 -07:00
**In other words, it applies to the current site only; it is *not* a global power button.** The state of the power switch for a specific site will be remembered.
2015-01-10 14:35:15 -07:00
For advanced usage, read about [dynamic filtering](https://github.com/gorhill/uBlock/wiki/Dynamic-filtering:-quick-guide) and more on [µBlock's wiki](https://github.com/gorhill/uBlock/wiki).
2014-10-13 08:18:15 -06:00
2014-06-22 18:00:34 -06:00
## About
2014-08-25 16:51:39 -06: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 14:33:36 -06:00
all for free.
You can contribute by helping to translate this project. There's an
[entry on Crowdin](https://crowdin.net/project/ublock) where you may contribute to µBlock's localization.
2014-07-05 14:03:59 -06:00
2014-06-22 18:00:34 -06:00
## License
2014-06-23 23:55:32 -06:00
[GPLv3](https://github.com/gorhill/uBlock/blob/master/LICENSE.txt).