Badges

NixCI can produce nice badges for you to put in your README file to show that your project passes NixCI. The repository badge shows the status of your default branch.

The easiest way to get the right snippet for your repository is the Badge button on the repository overview page. That fills in this page with snippets for your specific repository.

Repository badge (example)

The badge URL is:

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

Markdown:

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

HTML:

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

Renders as:

NixCI: PASSINGPASSING

Per-branch badge

To make a badge for a specific branch, append the branch name to the URL. Replace yourbranchnamehere with your branch name:

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