aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
blob: 02a4a8955445ae4d9100b5473bb60f6172cbc7a5 (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
25
26
# Checkmate

<p>
    <a href="https://godoc.org/github.com/eugenetriguba/checkmate">
        <img src="https://godoc.org/github.com/eugenetriguba/checkmate?status.svg" alt="GoDoc">
    </a>
    <a href="https://goreportcard.com/report/github.com/eugenetriguba/checkmate">
        <img src="https://goreportcard.com/badge/github.com/eugenetriguba/checkmate" alt="Go Report Card Badge">
    </a>
    <a href="https://codecov.io/github/eugenetriguba/checkmate">
        <img src="https://codecov.io/github/eugenetriguba/checkmate/branch/main/graph/badge.svg?token=Z3ZD0JWGBr"/>
    </a>
    <img alt="Version Badge" src="https://img.shields.io/badge/version-0.1.0-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.

This is a simple and small library. If you need something more advanced and full-featured, [Testify](https://github.com/stretchr/testify), [Gomega](https://github.com/onsi/gomega), or [gotest.tools](https://github.com/gotestyourself/gotest.tools) are all great options.

## Installation

To install Checkmate, use the following command:

```bash
$ go get github.com/eugenetriguba/checkmate
```