aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <hello@eugenetriguba.com>2025-08-17 10:38:55 -0400
committerEugene Triguba <hello@eugenetriguba.com>2025-08-17 10:38:55 -0400
commitc7d599904d7654bf15d1aae00855f943c700f6a1 (patch)
treebfaf7f105bf913d1487c2191a5c91e9367dd62bb
parentAdjust docs (diff)
downloadcheckmate-c7d599904d7654bf15d1aae00855f943c700f6a1.zip
Adjust docs to reference overview
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index 09cfbf4..10fd5bf 100644
--- a/README.md
+++ b/README.md
@@ -23,5 +23,6 @@ $ go get git.sr.ht/~eugenetriguba/checkmate
## Reference
For documentation on the API, see:
-- `assert`: https://pkg.go.dev/git.sr.ht/~eugenetriguba/checkmate/assert
-- `check`: https://pkg.go.dev/git.sr.ht/~eugenetriguba/checkmate/check
+- [Overview](https://pkg.go.dev/git.sr.ht/~eugenetriguba/checkmate)
+- [assert package](https://pkg.go.dev/git.sr.ht/~eugenetriguba/checkmate/assert)
+- [check package](https://pkg.go.dev/git.sr.ht/~eugenetriguba/checkmate/check)