mirror of
https://github.com/gorhill/uBlock.git
synced 2024-11-05 18:32:30 +01:00
Update README.md
This commit is contained in:
Chris Aljoudi
parent
a35d8e37e1
commit
a5d1064e45
70
README.md
70
README.md
@ -6,21 +6,16 @@
|
||||
</a>
|
||||
</h1>
|
||||
|
||||
[**uBlock**](https://chrismatic.io/ublock/): an efficient blocker add-on for various browsers. Fast, potent, and lean. [<img src="https://travis-ci.org/chrisaljoudi/uBlock.svg?branch=master" height="16">](https://travis-ci.org/chrisaljoudi/uBlock)
|
||||
##### [**uBlock**](https://chrismatic.io/ublock/): an efficient blocker add-on for various browsers. Fast, potent, and lean. [<img src="https://travis-ci.org/chrisaljoudi/uBlock.svg?branch=master" height="16">](https://travis-ci.org/chrisaljoudi/uBlock)
|
||||
|
||||
---
|
||||
|
||||
* [What is uBlock?](#what-is-ublock)
|
||||
* [Documentation](#documentation)
|
||||
* [Performance and Efficiency](#performance)
|
||||
* [Memory](#memory)
|
||||
* [CPU](#cpu)
|
||||
* [Blocking](#blocking)
|
||||
* [Quick tests](#quick-tests)
|
||||
* [Installation](#installation)
|
||||
* [General Info](#general-info)
|
||||
* [Chrome](#chromium)
|
||||
* [Firefox](#firefox)
|
||||
* [Safari](#safari)
|
||||
* [Performance & Benchmarks](#performance)
|
||||
* [Documentation](#documentation)
|
||||
* [Release History](#release-history)
|
||||
* [Tips](#tips)
|
||||
* [Wiki](https://github.com/chrisaljoudi/uBlock/wiki)
|
||||
|
||||
## What is uBlock?
|
||||
@ -29,10 +24,19 @@ uBlock is a general-purpose blocker — not an *ad blocker* specifically.
|
||||
|
||||
uBlock blocks ads through its support of the [Adblock Plus filter syntax](https://adblockplus.org/en/filters). uBlock [extends](https://github.com/chrisaljoudi/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 blocking ads [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.
|
||||
|
||||
uBlock's main goal is to help users neutralize privacy-invading apparatus — ads being one example.
|
||||
|
||||
## Installation
|
||||
|
||||
* **Safari**: available to install [from the homepage](https://chrismatic.io/ublock/safari/), or from the [Safari Extension Gallery](https://extensions.apple.com/details/?id=net.chrisaljoudi.uBlock-96G4BAKDQ9).
|
||||
|
||||
* **Chrome**: available on the [Chrome Web Store](https://chrome.google.com/webstore/detail/ublock/epcnnfbjfcgphgdmggkamkmgojdagdnn), the [Opera store](https://addons.opera.com/en-gb/extensions/details/ublock/), or for [manual](https://github.com/chrisaljoudi/uBlock/tree/master/dist#install) installation.
|
||||
|
||||
* **Firefox**: available on the [Firefox Add-ons homepage](https://addons.mozilla.org/en-US/firefox/addon/ublock/), or for [manual]((https://github.com/chrisaljoudi/uBlock/releases)) installation.
|
||||
|
||||
* Due to Mozilla's review process, the version of uBlock available from the Add-ons homepage is often outdated. This isn't in our control.
|
||||
|
||||
|
||||
## Documentation
|
||||
|
||||
[Quick guide: popup user interface](https://github.com/chrisaljoudi/uBlock/wiki/Quick-guide:-popup-user-interface)
|
||||
@ -86,38 +90,22 @@ Being lean and efficient doesn't mean blocking less<br>
|
||||
- [Web page components](http://raymondhill.net/ublock/tiles1.html)
|
||||
- [Popups](http://raymondhill.net/ublock/popup.html)
|
||||
|
||||
## Installation
|
||||
|
||||
#### General info
|
||||
|
||||
_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 can 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.
|
||||
|
||||
**To benefit from uBlock'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.
|
||||
|
||||
Feel free to read [about the extension's required permissions](https://github.com/chrisaljoudi/uBlock/wiki/About-the-required-permissions).
|
||||
|
||||
#### Chromium
|
||||
|
||||
You can install the latest version from the [Chrome Web Store](https://chrome.google.com/webstore/detail/ublock/epcnnfbjfcgphgdmggkamkmgojdagdnn), from the [Opera store](https://addons.opera.com/en-gb/extensions/details/ublock/), or [manually](https://github.com/chrisaljoudi/uBlock/tree/master/dist#install).
|
||||
|
||||
#### Firefox
|
||||
|
||||
Install from [Firefox Add-ons homepage](https://addons.mozilla.org/en-US/firefox/addon/ublock/), or you can install by downloading the latest [uBlock.firefox.xpi](https://github.com/chrisaljoudi/uBlock/releases) file, and by dragging the downloaded `xpi` file to your add-on page.
|
||||
|
||||
<sup>**Note:** When a new version is submitted at _Mozilla Add-ons_ (AMO), it takes **weeks** for that submission to be reviewed and cleared. Any new submission would cancel the pending one, and the new one would be placed at the end of the reviewing queue. So that the version on AMO is way behind the latest release here is completely out of control of the developers.</sup>
|
||||
|
||||
#### Safari
|
||||
|
||||
Install the latest uBlock for Safari [from its homepage](https://chrismatic.io/ublock/), or a potentially-outdated version from the [Safari Extension Gallery](https://extensions.apple.com/details/?id=net.chrisaljoudi.uBlock-96G4BAKDQ9).
|
||||
|
||||
<sup>Safari 6.1 and later (developed on Safari 8/Yosemite; tested on 6.1/Mountain Lion and 7/Mavericks).</sup>
|
||||
|
||||
## Release History
|
||||
|
||||
See the [releases pages](https://github.com/chrisaljoudi/uBlock/releases) for a history of releases and highlights for each release.
|
||||
|
||||
## Tips
|
||||
|
||||
* **To benefit from uBlock'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.
|
||||
|
||||
* It's important to note that blocking ads [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.
|
||||
|
||||
* _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 can 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.
|
||||
|
||||
* Feel free to read [about the extension's required permissions](https://github.com/chrisaljoudi/uBlock/wiki/About-the-required-permissions).
|
||||
|
||||
## About
|
||||
|
||||
[uBlock's manifesto](MANIFESTO.md).
|
||||
|
||||
Loading…
Reference in New Issue
Block a user