Badges

NixCI can produce nice badges for you to put in your README file to show that your project passes NixCI.

Step 1: Navigate to your repository

First, go to your repository's page on NixCI and copy the URL from your navigation bar. It should look something like this:

https://nix-ci.com/account/repo/gh:NorfairKing:nix-ci

The part that says gh:NorfairKing:nix-ci is the important part.

Step 2: Produce a badge URL

Next, produce a badge url according to the following pattern. Here it would look like this:

https://nix-ci.com/badge/gh:NorfairKing:nix-ci

To make a per-branch badge, you can add the branch name to the url like this:

https://nix-ci.com/badge/gh:NorfairKing:nix-ci/mybranch

Step 3: Add the badge to your page

In markdown, you can add your badge like this:

![NixCI Badge](https://nix-ci.com/badge/gh:NorfairKing:nix-ci)

In HTML, you can add your badge like this:

<img src="https://nix-ci.com/badge/gh:NorfairKing:nix-ci" alt="NixCI Badge">

It should look like this:

NixCI Badge