aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2024-01-27 21:58:54 -0500
committerEugene Triguba <eugenetriguba@gmail.com>2024-01-27 21:58:54 -0500
commitefd0607baf4621aabc4cbf4b1fd12c703634275b (patch)
tree4e7b6ff85d67cc6d595cf70cf6dd3e5a50611dd3 /README.md
downloadcheckmate-efd0607baf4621aabc4cbf4b1fd12c703634275b.zip
Initial Commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9fb5294
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# Checkmate
+
+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 github.com/eugenetriguba/checkmate
+```