prehistoric-systems/FilterLists
1
0
Fork 0
mirror of https://github.com/collinbarrett/FilterLists.git synced 2026-03-11 09:04:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

refactor(readme): ♻ tidy services shields

Browse source
This commit is contained in:
Collin M. Barrett 2021-01-23 12:30:46 -06:00
parent 1a1a1ee832
commit 6aba478efb
1 changed files with 10 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
.github/README.md vendored
View file

@ -2,21 +2,11 @@
<p align="center">
<a href="https://twitter.com/FilterLists"><img alt="Twitter" src="https://img.shields.io/twitter/follow/FilterLists?style=social"></a>
<a href="https://filterlists.com/api"><img alt="Swagger UI" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=API%20Docs" /></a>
<a href="https://github.com/collinbarrett/FilterLists/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/collinbarrett/filterlists.svg"></a>
<a href="https://github.com/collinbarrett/FilterLists/blob/master/LICENSE"><img alt="License" src="https://img.shields.io/github/license/collinbarrett/filterlists.svg?label=License"></a>
<a href="https://builtwithdot.net/project/125/filterlists"><img alt="BuiltWithDot.net" src="https://builtwithdot.net/project/125/filterlists/badge" /></a>
<a href="https://madewithreactjs.com/p/filterlists/shield-link"><img alt="MadeWithReactJS.com" src="https://madewithreactjs.com/storage/repo-shields/2335-shield.svg"/></a>
<br/>FilterLists is the independent, comprehensive directory of filter and host lists for advertisements, trackers, malware, and annoyances.</p>
# Services
| Service | Description | More |
|---|---|---|
| Website | A React & TypeScript UI built with Ant Design. | <a href="https://filterlists.com/"><img alt="Website" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=Website" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=18"><img alt="Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Web?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=4"><img alt="Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/4/5" /></a> <a href="https://github.com/users/collinbarrett/packages/container/package/filterlists-web"><img alt="Docker Image" src="https://img.shields.io/badge/docker%20image-web-blue" /></a> |
| Directory API | An ASP.NET Core API serving the core FilterList information. | <a href="https://filterlists.com/api/?urls.primaryName=Directory"><img alt="Swagger UI" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=Directory%20API" /></a> <a href="https://filterlists.com/api/directory/v1/swagger.json"><img alt="OpenAPI Specification" src="https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json" ></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=27"><img alt="Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Directory%20API?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=3"><img alt="Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/3/4" /></a> <a href="https://github.com/users/collinbarrett/packages/container/package/filterlists-directory-api"><img alt="Docker Image" src="https://img.shields.io/badge/docker%20image-directory--api-blue" /></a> |
| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | <a href="https://filterlists.com/api/?urls.primaryName=Archival"><img alt="Swagger UI" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=Archival%20API" /></a> <a href="https://filterlists.com/api/archival/v1/swagger.json"><img alt="OpenAPI Specification" src="https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json" ></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=29"><img alt="Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Archival%20API?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=7"><img alt="Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/7/8" /></a> <a href="https://github.com/users/collinbarrett/packages/container/package/filterlists-archival-api"><img alt="Docker Image" src="https://img.shields.io/badge/docker%20image-archival--api-blue" /></a> |
| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=21"><img alt="Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Reverse%20Proxy?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=5"><img alt="Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/5/6" /></a> <a href="https://observatory.mozilla.org/analyze/filterlists.com"><img alt="Mozilla HTTP Observatory Grade" src="https://img.shields.io/mozilla-observatory/grade/filterlists.com?publish"></a> <a href="https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com"><img alt="Security Headers" src="https://img.shields.io/security-headers?url=https%3A%2F%2Ffilterlists.com"></a> <a href="https://hstspreload.org/?domain=filterlists.com"><img alt="Chromium HSTS preload" src="https://img.shields.io/hsts/preload/filterlists.com"></a> |
# Background
FilterLists helps to protect your privacy and security when using the internet. It provides a comprehensive directory of subscription lists to block advertisements, malware, trackers, and other general annoyances. First, install one of the software tools that supports these lists. Then you can subscribe to a set of these lists inside of that software. If you need help or have a comment/question, open an [Issue](https://github.com/collinbarrett/FilterLists/issues).
@ -25,6 +15,15 @@ Using a software firewall or adblocker has become a key tool in protecting one's
Typical adblockers run as an extension in popular web browsers. As we browse the internet, they compare HTTP requests to their list of hosts and filters to selectively block advertisements, trackers, and malware. This filtering helps to protect the surfer's privacy, prevents [malvertising attacks](http://www.wired.com/insights/2014/11/malvertising-is-cybercriminals-latest-sweet-spot/ "Why Malvertising Is Cybercriminals' Latest Sweet Spot - Wired"), and [reduces bandwidth requirements](http://venturebeat.com/2015/07/08/blocking-ads-can-cut-network-traffic-25-to-40-study-shows/ "Blocking Ads Can Cut Network Traffic 25% to 40%, Study Shows - VentureBeat"). Thousands of contributors work hard to maintain these FilterLists for anyone to use. Locating and selecting these lists, however, has not historically been very easy. This project was launched in 2015 to solve that problem.
# Services
| Service | Description | More |
|---|---|---|
| Website | A React & TypeScript UI built with Ant Design. | <a href="https://filterlists.com/"><img alt="Website" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=Website" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=18"><img alt="Website Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Web?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=4"><img alt="Website Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/4/5" /></a> <a href="https://github.com/users/collinbarrett/packages/container/package/filterlists-web"><img alt="Website Docker Image" src="https://img.shields.io/badge/docker%20image-web-blue?label=Docker Image" /></a> |
| Directory API | An ASP.NET Core API serving the core FilterList information. | <a href="https://filterlists.com/api/?urls.primaryName=Directory"><img alt="Directory API Swagger UI" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=API%20Docs" /></a> <a href="https://filterlists.com/api/directory/v1/swagger.json"><img alt="Directory API OpenAPI Specification" src="https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json" ></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=27"><img alt="Directory API Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Directory%20API?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=3"><img alt="Directory API Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/3/4" /></a> <a href="https://github.com/users/collinbarrett/packages/container/package/filterlists-directory-api"><img alt="Directory API Docker Image" src="https://img.shields.io/badge/docker%20image-directory--api-blue?label=Docker Image" /></a> |
| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | <a href="https://filterlists.com/api/?urls.primaryName=Archival"><img alt="Archival API Swagger UI" src="https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=API%20Docs" /></a> <a href="https://filterlists.com/api/archival/v1/swagger.json"><img alt="Archival API OpenAPI Specification" src="https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json" ></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=29"><img alt="Archival API Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Archival%20API?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=7"><img alt="Archival API Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/7/8" /></a> <a href="https://github.com/users/collinbarrett/packages/container/package/filterlists-archival-api"><img alt="Archival API Docker Image" src="https://img.shields.io/badge/docker%20image-archival--api-blue?label=Docker Image" /></a> |
| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | <a href="https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=21"><img alt="Reverse Proxy Azure DevOps builds" src="https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Reverse%20Proxy?branchName=master" /></a> <a href="https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=5"><img alt="Reverse Proxy Azure DevOps releases" src="https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/5/6" /></a> <a href="https://observatory.mozilla.org/analyze/filterlists.com"><img alt="Reverse Proxy Mozilla HTTP Observatory Grade" src="https://img.shields.io/mozilla-observatory/grade/filterlists.com?publish"></a> <a href="https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com"><img alt="Reverse Proxy Security Headers" src="https://img.shields.io/security-headers?url=https%3A%2F%2Ffilterlists.com"></a> <a href="https://hstspreload.org/?domain=filterlists.com"><img alt="Reverse Proxy Chromium HSTS preload" src="https://img.shields.io/hsts/preload/filterlists.com"></a> |
# Contributing
## Adding or Updating Lists