Merge pull request #5 from vasayxtx/godoc-badge

Add Go doc badge and installation section in README.md
acronis · Dec 13, 2024 · 49e7ab1 · 49e7ab1
2 parents 0a5a7a5 + fd873e5
commit 49e7ab1
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
 # Toolkit for working with SQL databases in Go
 
+[![GoDoc Widget]][GoDoc]
+
+## Installation
+
+```
+go get -u github.com/acronis/go-dbkit
+```
+
 ## Structure
 
 ### `/`
@@ -157,3 +165,6 @@ fmt.Println("Lock released")
 Copyright © 2024 Acronis International GmbH.
 
 Licensed under [MIT License](./LICENSE).
+
+[GoDoc]: https://pkg.go.dev/github.com/acronis/go-dbkit
+[GoDoc Widget]: https://godoc.org/github.com/acronis/go-dbkit?status.svg