aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 790cafcab5df495556d87bb2cb584fa868ee4920 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# Checkmate

<p>
    <a href="https://godoc.org/git.sr.ht/~eugenetriguba/checkmate">
        <img src="https://godoc.org/git.sr.ht/~eugenetriguba/checkmate?status.svg" alt="GoDoc">
    </a>
    <a href="https://goreportcard.com/report/git.sr.ht/~eugenetriguba/checkmate">
        <img src="https://goreportcard.com/badge/git.sr.ht/~eugenetriguba/checkmate" alt="Go Report Card Badge">
    </a>
    <a href="https://codecov.io/git.sr.ht/~eugenetriguba/checkmate">
        <img src="https://codecov.io/git.sr.ht/~eugenetriguba/checkmate/branch/main/graph/badge.svg?token=Z3ZD0JWGBr"/>
    </a>
    <img alt="Version Badge" src="https://img.shields.io/badge/version-0.3.2-blue" style="max-width:100%;">
</p>

Checkmate is a Go library designed to enhance the testing experience by providing a set of assertion functions. With Go, there is no built-in assertion library which can make writing tests feel more verbose than it needs to be, so Checkmate aims to fill that gap.

## Installation

To install Checkmate, use the following command:

```bash
$ go get git.sr.ht/~eugenetriguba/checkmate
```