refactor(readme): ♻ convert services shields to markdown, extract multiple security headers shields

This commit is contained in:
Collin M. Barrett 2021-01-24 09:48:53 -06:00
parent 56f96bd3bd
commit 8930e33bd9

8
.github/README.md vendored
View file

@ -19,10 +19,10 @@ Typical adblockers run as an extension in popular web browsers. As we browse the
| 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> |
| Website | A React & TypeScript UI built with Ant Design. | [![Website](https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=Website)](https://filterlists.com/) [![Website Azure DevOps builds](https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Web?branchName=master)](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=18) [![Website Azure DevOps releases](https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/4/5)](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=4) [![Website Docker Image](https://img.shields.io/badge/docker%20image-web-blue?label=Docker%20Image)](https://github.com/users/collinbarrett/packages/container/package/filterlists-web) [![Website Security Headers](https://img.shields.io/security-headers?url=https%3A%2F%2Ffilterlists.com)](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2F) |
| Directory API | An ASP.NET Core API serving the core FilterList information. | [![Directory API Swagger UI](https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=API%20Docs)](https://filterlists.com/api/?urls.primaryName=Directory) [![Directory API OpenAPI Specification](https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json)](https://filterlists.com/api/directory/v1/swagger.json) [![Directory API Azure DevOps builds](https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Directory%20API?branchName=master)](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=27) [![Directory API Azure DevOps releases](https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/3/4)](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=3) [![Directory API Docker Image](https://img.shields.io/badge/docker%20image-directory--api-blue?label=Docker%20Image)](https://github.com/users/collinbarrett/packages/container/package/filterlists-directory-api) [![Directory API Security Headers](https://img.shields.io/security-headers?url=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json)](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2Fapi%2Fdirectory%2Fv1%2Fswagger.json) |
| Archival API | An ASP.NET Core API archiving and serving copies of FilterLists for mirrors and analysis. | [![Archival API Swagger UI](https://img.shields.io/website-up-down-green-red/http/shields.io.svg?label=API%20Docs)](https://filterlists.com/api/?urls.primaryName=Archival) [![Archival API OpenAPI Specification](https://img.shields.io/swagger/valid/3.0?specUrl=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json)](https://filterlists.com/api/archival/v1/swagger.json) [![Archival API Azure DevOps builds](https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Archival%20API?branchName=master)](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=29) [![Archival API Azure DevOps releases](https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/7/8)](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=7) [![Archival API Docker Image](https://img.shields.io/badge/docker%20image-archival--api-blue?label=Docker%20Image)](https://github.com/users/collinbarrett/packages/container/package/filterlists-archival-api) [![Archival API Security Headers](https://img.shields.io/security-headers?url=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json)](https://securityheaders.com/?q=https%3A%2F%2Ffilterlists.com%2Fapi%2Farchival%2Fv1%2Fswagger.json) |
| Reverse Proxy | An NGINX instance forwarding requests to the respective services above. | [![Reverse Proxy Azure DevOps builds](https://dev.azure.com/collinbarrett/FilterLists/_apis/build/status/Reverse%20Proxy?branchName=master)](https://dev.azure.com/collinbarrett/FilterLists/_build/latest?definitionId=21) [![Reverse Proxy Azure DevOps releases](https://vsrm.dev.azure.com/collinbarrett/_apis/public/Release/badge/b06a3d5c-459e-4789-9735-0f5969006fe8/5/6)](https://dev.azure.com/collinbarrett/FilterLists/_release?definitionId=5) [![Reverse Proxy Mozilla HTTP Observatory Grade](https://img.shields.io/mozilla-observatory/grade/filterlists.com?publish)](https://observatory.mozilla.org/analyze/filterlists.com) [![Reverse Proxy Chromium HSTS preload](https://img.shields.io/hsts/preload/filterlists.com)](https://hstspreload.org/?domain=filterlists.com) |
# Contributing