diff --git a/.github/README.md b/.github/README.md index f2a44d211..47d97d74d 100644 --- a/.github/README.md +++ b/.github/README.md @@ -2,21 +2,11 @@

Twitter -Swagger UI -License +License BuiltWithDot.net MadeWithReactJS.com
FilterLists is the independent, comprehensive directory of filter and host lists for advertisements, trackers, malware, and annoyances.

-# Services - -| Service | Description | More | -|---|---|---| -| Website | A React & TypeScript UI built with Ant Design. | Website Azure DevOps builds Azure DevOps releases Docker Image | -| Directory API | An ASP.NET Core API serving the core FilterList information. | Swagger UI OpenAPI Specification Azure DevOps builds Azure DevOps releases Docker Image | -| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | Swagger UI OpenAPI Specification Azure DevOps builds Azure DevOps releases Docker Image | -| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | Azure DevOps builds Azure DevOps releases Mozilla HTTP Observatory Grade Security Headers Chromium HSTS preload | - # 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. | Website Website Azure DevOps builds Website Azure DevOps releases Website Docker Image | +| Directory API | An ASP.NET Core API serving the core FilterList information. | Directory API Swagger UI Directory API OpenAPI Specification Directory API Azure DevOps builds Directory API Azure DevOps releases Directory API Docker Image | +| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | Archival API Swagger UI Archival API OpenAPI Specification Archival API Azure DevOps builds Archival API Azure DevOps releases Archival API Docker Image | +| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | Reverse Proxy Azure DevOps builds Reverse Proxy Azure DevOps releases Reverse Proxy Mozilla HTTP Observatory Grade Reverse Proxy Security Headers Reverse Proxy Chromium HSTS preload | + # Contributing ## Adding or Updating Lists