prehistoric-systems/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2026-03-11 09:04:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
uBlock/README.md

185 lines
9.4 KiB
Markdown
Raw Normal View History

Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[![Badge Commits]][Commit Rate]
[![Badge Issues]][Issues]
[![Badge Localization]][Crowdin]
[![Badge License]][License]
[![Badge NPM]][NPM]
[![Badge Mozilla]][Mozilla]
[![Badge Chrome]][Chrome]
Update README.md
2023-04-29 18:02:59 +00:00
[![Badge Edge]][Edge]
Update README.md
2015-05-27 11:15:51 +00:00
fix(curben-filter): curben.gitlab.io migrated to malware-filter.gitlab.io (#3867)
2022-06-03 16:46:10 +00:00
***
Update README.md
2015-04-04 11:34:38 +00:00
First attempt at cleaning up the header
2015-03-08 00:31:27 +00:00
<h1 align="center">
<sub>
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
<img src="https://github.com/gorhill/uBlock/blob/master/src/img/ublock.svg" height="38" width="38">
First attempt at cleaning up the header
2015-03-08 00:31:27 +00:00
</sub>
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
uBlock Origin (uBO)
Cleanup markup/HTML mess; make code readable (somewhat)
2015-03-08 00:51:36 +00:00
</h1>
Add links to uBO in supported browser stores
2021-02-08 21:13:59 +00:00
Update README.md
2025-05-17 12:10:49 +00:00
| Browser | Install from ... | Status |
| :-------: | ---------------- | ------ |
| <img src="https://github.com/user-attachments/assets/b0136512-56a5-4856-8c50-4971c957a24f" alt="Get uBlock Origin for Firefox"> | <a href="https://addons.mozilla.org/addon/ublock-origin/">Firefox Add-ons</a> | [uBO works best on Firefox](https://github.com/gorhill/uBlock/wiki/uBlock-Origin-works-best-on-Firefox) |
Edge status update (#3940)
2025-06-07 10:39:46 +00:00
| <img src="https://github.com/user-attachments/assets/3a7569f8-688b-4eb1-a643-8d0fe173aefe" alt="Get uBlock Origin for Microsoft Edge"> | <a href="https://microsoftedge.microsoft.com/addons/detail/ublock-origin/odfafepnkmbhccpbejgmiehpchacaeak">Edge Add-ons</a> |
Update README.md
2025-05-17 12:10:49 +00:00
| <img src="https://github.com/user-attachments/assets/938f080c-fe64-4e48-8b89-4bfceabb56e6" alt="Get uBlock Origin for Opera"> | <a href="https://addons.opera.com/extensions/details/ublock/">Opera Add-ons</a> |
Edge status update (#3940)
2025-06-07 10:39:46 +00:00
| <img src="https://github.com/user-attachments/assets/5463ef88-873b-4516-8514-5277664cfde7" alt="Get uBlock Origin for Chromium"> | <a href="https://chromewebstore.google.com/detail/ublock-origin-lite/ddkjiahejlhfcafbddmgiahcphecmpfh">Chrome Web Store</a> | <a href="https://github.com/uBlockOrigin/uBlock-issues/wiki/About-Google-Chrome's-%22This-extension-may-soon-no-longer-be-supported%22">About Google Chrome's "This extension may soon no longer be supported"</a><br>End of support on Chrome 139 |
Update README.md
2025-05-17 12:10:49 +00:00
| <img src="https://github.com/user-attachments/assets/2e9037c4-836d-44c1-a716-ba96e89daaff" alt="Get uBlock Origin for Thunderbird"> | <a href="https://addons.thunderbird.net/en-Us/thunderbird/addon/ublock-origin/">Thunderbird Add-ons</a> | [No longer updated and stuck at 1.49.2](https://github.com/uBlockOrigin/uBlock-issues/issues/2928) |
Update README.md
2024-07-24 16:43:00 +00:00
***
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
uBlock Origin (uBO) is a CPU and memory-efficient [wide-spectrum content blocker][Blocking] for Chromium and Firefox. It blocks ads, trackers, coin miners, popups, annoying anti-blockers, malware sites, etc., by default using [EasyList][EasyList], [EasyPrivacy][EasyPrivacy], [Peter Lowe's Blocklist][Peter Lowe's Blocklist], [Online Malicious URL Blocklist][Malicious Blocklist], and uBO [filter lists][uBO Filters]. There are many other lists available to block even more. Hosts files are also supported. uBO uses the EasyList filter syntax and [extends][Extended Syntax] the syntax to work with custom rules and filters.
Update README.md Merged the initial brief description paragraph with the general information section for conciseness and to reduce large amounts of redundancy. Merged both "Do NOT" statements in the All Browsers section for conciseness and to reduce redundancy. Rewrote and restructured the new primary section for conciseness and consistency and to eliminate redundancy as needed. Removed obsolete sentence from the About section. Other minor cleanups and fixes.
2023-04-14 18:28:14 +00:00
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
You may easily unselect any preselected filter lists if you think uBO blocks too much. For reference, Adblock Plus installs with only EasyList, ABP filters, and Acceptable Ads enabled by default.
Update README.md Merged the initial brief description paragraph with the general information section for conciseness and to reduce large amounts of redundancy. Merged both "Do NOT" statements in the All Browsers section for conciseness and to reduce redundancy. Rewrote and restructured the new primary section for conciseness and consistency and to eliminate redundancy as needed. Removed obsolete sentence from the About section. Other minor cleanups and fixes.
2023-04-14 18:28:14 +00:00
It is important to note that using a blocker is **NOT** [theft]. Do not fall for this creepy idea. The _ultimate_ logical consequence of `blocking = theft` is the criminalization of the inalienable right to privacy.
Update README.md (#3887) * Update README.md Removed uMatrix reference and trimmed sentence. * Update README.md Removed uMatrix URL from the reference links.
2023-04-15 12:17:21 +00:00
Ads, "unintrusive" or not, are just the visible portion of the privacy-invading means entering your browser when you visit most sites. **uBO's primary goal is to help users neutralize these privacy-invading methods** in a way that welcomes those users who do not wish to use more technical means.
Update README.md
2017-10-21 12:55:19 +00:00
Add links to uBO in supported browser stores
2021-02-08 21:13:59 +00:00
***
Update README.md
2015-03-27 20:21:31 +00:00
* [Documentation](#documentation)
Updating README: Alignment of the logo and name
2015-01-13 21:25:08 +00:00
* [Installation](#installation)
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
* [Firefox](#firefox)
Add thunderbird as target for installation
2023-04-28 02:40:14 +00:00
* [Thunderbird](#thunderbird)
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
* [Chromium](#chromium)
* [All Programs](#all-programs)
* [Enterprise Deployment](#enterprise-deployment)
Updating README: Alignment of the logo and name
2015-01-13 21:25:08 +00:00
* [Release History](#release-history)
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
* [Translations](#translations)
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
* [About](#about)
first commit
2014-06-23 00:00:34 +00:00
Update README.md
2015-08-06 22:48:47 +00:00
## Documentation
Update README.md Add up to date images of popup panel; use HTML table to better control vertical alignment
2023-04-17 15:36:50 +00:00
<table>
<thead>
<tr>
Update README.md (#3893) Shortened Popup UI table header names. Improved Popup UI table by combining descriptions and information into one sentence for each column. Removed no longer needed reference links.
2023-04-17 23:04:40 +00:00
<th>Basic Mode</th>
<th>Advanced Mode</th>
Update README.md Add up to date images of popup panel; use HTML table to better control vertical alignment
2023-04-17 15:36:50 +00:00
</tr>
</thead>
<tbody>
<tr>
Update README.md
2023-04-17 23:06:43 +00:00
<td>The <a href="https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface">simple popup user interface</a> for an install-it-and-forget-it type of installation that is configured optimally by default.</td>
<td>The <a href="https://github.com/gorhill/uBlock/wiki/Dynamic-filtering:-quick-guide">advanced popup user interface</a> includes a point-and-click firewall that is configurable on a per-site basis.</td>
Update README.md Add up to date images of popup panel; use HTML table to better control vertical alignment
2023-04-17 15:36:50 +00:00
</tr>
<tr>
Update README.md
2023-04-17 23:06:43 +00:00
<td align="center" valign="top"><a href="https://github.com/gorhill/uBlock/wiki/Quick-guide:-popup-user-interface"><img src="https://user-images.githubusercontent.com/585534/232531044-c4ac4dd5-0b60-4c1e-aabb-914be04b846c.png"/></a></td>
<td align="center" valign="top"><a href="https://github.com/gorhill/uBlock/wiki/Dynamic-filtering:-quick-guide"><img src="https://user-images.githubusercontent.com/585534/232531439-a8f81cc3-6622-45c4-8b32-7348cecf6e98.png"/></a></td>
Update README.md Add up to date images of popup panel; use HTML table to better control vertical alignment
2023-04-17 15:36:50 +00:00
</tr>
</tbody>
</table>
Update README.md
2015-08-06 22:48:47 +00:00
Update README.md Merged the initial brief description paragraph with the general information section for conciseness and to reduce large amounts of redundancy. Merged both "Do NOT" statements in the All Browsers section for conciseness and to reduce redundancy. Rewrote and restructured the new primary section for conciseness and consistency and to eliminate redundancy as needed. Removed obsolete sentence from the About section. Other minor cleanups and fixes.
2023-04-14 18:28:14 +00:00
Visit the [Wiki][Wiki] for documentation.
Update README.md
2015-08-06 22:48:47 +00:00
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
For support, questions, or help, visit [/r/uBlockOrigin][Reddit].
Update README.md
2017-07-08 23:48:05 +00:00
first commit
2014-06-23 00:00:34 +00:00
## Installation
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Required Permissions][Permissions]
Overhaul README Indexed, reorganized, some revision — big overhaul
2015-01-12 19:55:44 +00:00
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
#### Firefox
Revert "Update README.md" This reverts commit 1854009c740dd588b33e60d02b41d53acb5160d6.
2022-11-15 15:01:05 +00:00
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Firefox Add-ons][Mozilla]
Add heads up for Safari 13+ users (#3758) See https://github.com/uBlockOrigin/uBlock-issues/issues/747
2019-10-08 18:43:09 +00:00
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
[Development Builds][Beta]
Update README.md
2018-01-04 19:51:33 +00:00
Update README.md (#3892) * Update README.md Updated sentence in Firefox section to further address more feedback. * Update README.md Updated sentence in Firefox section to link to the corresponding Wiki article.
2023-04-17 15:05:00 +00:00
uBO [works best][Works Best] on Firefox and is available for desktop and Android versions.
Update README.md (#3891) Added sentence under Firefox section to specify that uBO works on Firefox for the desktop & Android.
2023-04-17 12:52:54 +00:00
Add thunderbird as target for installation
2023-04-28 02:40:14 +00:00
#### Thunderbird
[Thunderbird Add-ons][Thunderbird]
Fix #2874 as suggested
2023-10-16 00:16:44 +00:00
In Thunderbird, uBlock Origin does not affect emails, just feeds.
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
#### Chromium
[Chrome Web Store][Chrome]
Edge status update (#3940)
2025-06-07 10:39:46 +00:00
[Microsoft Edge Add-ons][Edge] (Published by [Nicole Rolls][Nicole Rolls] until version 1.62. Ownership transfer at version 1.64.)
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
[Opera Add-ons][Opera]
[Development Builds][Chrome Dev]
uBO should be compatible with any Chromium-based browser.
#### All Programs
first commit
2014-06-23 00:00:34 +00:00
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
Do **NOT** use uBO with any other content blocker. uBO [performs][Performance] as well as or better than most popular blockers. Other blockers can prevent uBO's privacy or anti-blocker-defusing features from working correctly.
Update README.md
2017-10-02 11:49:23 +00:00
Move "Manual installation" link to "All browsers" section
2022-11-15 16:07:15 +00:00
[Manual Installation][Manual Installation]
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
#### Enterprise Deployment
Update README.md
2017-10-02 11:49:23 +00:00
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Deploying uBO][Deployment]
Update README.md
2017-10-02 11:49:23 +00:00
Overhaul README Indexed, reorganized, some revision — big overhaul
2015-01-12 19:55:44 +00:00
## Release History
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Releases Page][Releases]
details re. permissions
2014-07-29 22:07:36 +00:00
Update README.md (#3890) Added dedicated Translations section and removed old corresponding sentence. Removed out of place sentence and corresponding links from reference links section and combined other sentence with first paragraph to reduce primary section for conciseness. Removed excessive descriptions for items that are implied or should be common knowledge today. Rewrote sentences as needed to provide more conciseness and reduce wordiness. Fixed grammar issues. Fixed consistency issues.
2023-04-16 23:16:17 +00:00
## Translations
Help translate uBO via [Crowdin][Crowdin].
first commit
2014-06-23 00:00:34 +00:00
## About
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Manifesto][Manifesto]
README: add link to manifesto, be more succinct
2015-02-23 19:50:49 +00:00
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
[Privacy Policy][Privacy Policy]
Actually, asking for one thing
2014-08-25 22:51:39 +00:00
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
[GPLv3 License][License]
add info about project on Crowdin
2014-07-05 20:03:59 +00:00
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
Free. Open-source. For users by users. No donations sought.
first commit
2014-06-23 00:00:34 +00:00
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
If you ever want to contribute something, think about the people working hard to maintain the filter lists you are using, which are available to use by all for free.
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
<!----------------------------------------------------------------------------->
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Peter Lowe's Blocklist]: https://pgl.yoyo.org/adservers/
[Malicious Blocklist]: https://gitlab.com/malware-filter/urlhaus-filter#malicious-url-blocklist
Update README.md (#3937)
2025-04-25 11:30:17 +00:00
[Performance]: https://www.debugbear.com/blog/chrome-extensions-website-performance#the-impact-of-ad-blocking-on-website-performance
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[EasyPrivacy]: https://easylist.to/#easyprivacy
Update README.md (#3896) * Update README.md Added Thunderbird references to match all other installation methods. Reordered sections to provide overall document consistency. Reordered reference links and removed unneeded ones. Renamed All Browsers section to All Programs to be more general and given the fact that Thunderbird is not a browser. Rewrote "'Do NOT" paragraph under All Programs section to provide consciousness and a more clear general message. Combined License & Privacy Links under About section. Other miscellaneous fixes, removals, cleanups, etc. * Update README.md Adjusted download button order as per feedback.
2023-04-29 17:36:37 +00:00
[Thunderbird]: https://addons.thunderbird.net/thunderbird/addon/ublock-origin/
Update links in readme
2024-11-01 14:46:37 +00:00
[Chrome Dev]: https://chromewebstore.google.com/detail/ublock-origin-development/cgbcahbpdhpcegmbfconppldiemgcoii
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[EasyList]: https://easylist.to/#easylist
[Mozilla]: https://addons.mozilla.org/addon/ublock-origin/
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[Crowdin]: https://crowdin.com/project/ublock
Update links in readme
2024-11-01 14:46:37 +00:00
[Chrome]: https://chromewebstore.google.com/detail/ublock-origin/cjpalhdlnbpafiamejdnhcphjbkeiagm
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[Reddit]: https://www.reddit.com/r/uBlockOrigin/
Update links in readme
2024-11-01 14:46:37 +00:00
[Theft]: https://x.com/LeaVerou/status/518154828166725632
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[Opera]: https://addons.opera.com/extensions/details/ublock/
[Edge]: https://microsoftedge.microsoft.com/addons/detail/ublock-origin/odfafepnkmbhccpbejgmiehpchacaeak
[NPM]: https://www.npmjs.com/package/@gorhill/ubo-core
[Manifesto]: MANIFESTO.md
[License]: LICENSE.txt
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Nicole Rolls]: https://github.com/nicole-ashley
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
<!---------------------------------[ Internal ]-------------------------------->
[Manual Installation]: https://github.com/gorhill/uBlock/tree/master/dist#install
[Extended Syntax]: https://github.com/gorhill/uBlock/wiki/Static-filter-syntax#extended-syntax
[Privacy Policy]: https://github.com/gorhill/uBlock/wiki/Privacy-policy
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[uBO Filters]: https://github.com/uBlockOrigin/uAssets/tree/master/filters
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[Permissions]: https://github.com/gorhill/uBlock/wiki/Permissions
[Commit Rate]: https://github.com/gorhill/uBlock/commits/master
Update README.md (#3892) * Update README.md Updated sentence in Firefox section to further address more feedback. * Update README.md Updated sentence in Firefox section to link to the corresponding Wiki article.
2023-04-17 15:05:00 +00:00
[Works Best]: https://github.com/gorhill/uBlock/wiki/uBlock-Origin-works-best-on-Firefox
Improve README.md (#3880) * Improve README.md Removed Safari references. (It has been several years since any relevancy.) Removed majority of Enterprise Deployment section. (Existing links are dead, or information provided is deprecated.) Merged Microsoft Edge section into Chromium section for simplification. (Microsoft Edge has been Chromium-based for the last few years.) Restructured and shortened sections, links, and explanations to make them more concise. Rewrote sentences for better clarity and to reduce wordiness. Fixed uBO naming conventions. Fixed spelling and grammar issues. Fixed coding and formatting issues. Fixed consistency issues. Updated names as needed. Updated section header titles as needed. Updated URLs. Other minor fixes. * Removed Pronunciation section as per feedback. Removed Pronunciation section. * Addressed feedback and fixed more consistency issues Removed Firefox Legacy section. Removed Debian section. Removed applicable links. Added links to remaining section headers without a prior link in the table of contents. Updated links in the table of contents to match section header names. Renamed Philosophy section to General Information section.
2022-11-15 16:05:50 +00:00
[Deployment]: https://github.com/gorhill/uBlock/wiki/Deploying-uBlock-Origin
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[Blocking]: https://github.com/gorhill/uBlock/wiki/Blocking-mode
[Releases]: https://github.com/gorhill/uBlock/releases
[Issues]: https://github.com/uBlockOrigin/uBlock-issues/issues
[Beta]: https://github.com/gorhill/uBlock/blob/master/dist/README.md#for-beta-version
[Wiki]: https://github.com/gorhill/uBlock/wiki
<!----------------------------------[ Badges ]--------------------------------->
[Badge Localization]: https://d322cqt584bo4o.cloudfront.net/ublock/localized.svg
[Badge Commits]: https://img.shields.io/github/commit-activity/m/gorhill/ublock?label=Commits
[Badge Mozilla]: https://img.shields.io/amo/rating/ublock-origin?label=Firefox
[Badge License]: https://img.shields.io/badge/License-GPLv3-blue.svg
[Badge Chrome]: https://img.shields.io/chrome-web-store/rating/cjpalhdlnbpafiamejdnhcphjbkeiagm?label=Chrome
Update README.md
2023-04-29 18:02:59 +00:00
[Badge Edge]: https://img.shields.io/badge/dynamic/json?label=Edge&color=brightgreen&query=%24.averageRating&suffix=%2F%35&url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Fodfafepnkmbhccpbejgmiehpchacaeak
Raw Links -> Link References
2022-04-30 00:37:56 +00:00
[Badge Issues]: https://img.shields.io/github/issues/uBlockOrigin/uBlock-issues
[Badge NPM]: https://img.shields.io/npm/v/@gorhill/ubo-core
Reference in a new issue Copy permalink