refactor(readme): ♻ extract services section/table

This commit is contained in:
Collin M. Barrett 2021-01-23 12:05:39 -06:00
parent 2efc8bff9a
commit 1a1a1ee832

36
.github/README.md vendored
View file

@ -8,36 +8,14 @@
<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>
<p align="center"><b>Website:</b>
<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>
<br/>A React & TypeScript UI built with Ant Design.</p>
# Services
<p align="center"><b>Directory API:</b>
<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>
<br/>An ASP.NET Core API serving the core FilterList information.</p>
<p align="center"><b>Archival API:</b>
<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>
<br/>An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis.</p>
<p align="center"><b>Reverse Proxy:</b>
<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>
<br/>An NGINX instance forwarding requests to the respective services above.</p>
| 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