Skip to main content

Status Badges

This document describes how to create a badge that displays your project’s build status (passed or failed) in a README or other document.

Adding Status Badges​

Status badges are commonly embedded in project READMEs, although they can be placed in any web document. A11yWatch provides a tool to generate embed code for status badges. By default, a badge displays the status of a project’s accessibility score.

Generating a status badge​

To generate your own status badge, you will need to know and substitute the following variables in the code snippets below:

<DOMAIN_NAME> - Your domains name. Example: a11ywatch.com

mardown:

[![A11yWatch](https://api.a11ywatch.com/status/a11ywatch.com)](https://a11ywatch.com/reports/a11ywatch.com)

html:

<a href="https://a11ywatch.com/reports/a11ywatch.com"
  ><img src="https://api.a11ywatch.com/status/a11ywatch.com"
/></a>