aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/README.md b/README.md
index 5bba852..379f727 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,23 @@
# 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 href="https://pkg.go.dev/git.eugenetriguba.com/checkmate">
+ <img src="https://pkg.go.dev/badge/git.eugenetriguba.com/checkmate.svg" alt="Go Reference">
</a>
<img alt="Version Badge" src="https://img.shields.io/badge/version-0.5.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.
+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
+$ go get git.eugenetriguba.com/checkmate
```
## Example Usage
@@ -26,8 +29,8 @@ import (
"errors"
"testing"
- "git.sr.ht/~eugenetriguba/checkmate/assert"
- "git.sr.ht/~eugenetriguba/checkmate/check"
+ "git.eugenetriguba.com/checkmate/assert"
+ "git.eugenetriguba.com/checkmate/check"
)
func TestUserCreation(t *testing.T) {
@@ -61,6 +64,6 @@ func TestValidateEmail_InvalidFormat(t *testing.T) {
For documentation on the API, see:
-- [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)
+- [Overview](https://pkg.go.dev/git.eugenetriguba.com/checkmate)
+- [assert package](https://pkg.go.dev/git.eugenetriguba.com/checkmate/assert)
+- [check package](https://pkg.go.dev/git.eugenetriguba.com/checkmate/check)