Add readme

gregoryv · Jun 8, 2024 · 9bf9ce2 · 9bf9ce2
1 parent c59cd08
commit 9bf9ce2
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,13 @@
+semstr - Go package for parsing and comparing [semantic version](https://semver.org) like strings
+
+Allowed format is less stringent than semantic versioning to
+accomodate more usecases.
+
+    [v]MAJOR[.MINOR[.PATCH[-PRERELEASE][+BUILD]]]
+
+
+## Quick use
+
+    go get [github.com/gregoryv/semstr](https://pkg.go.dev/github.com/gregoryv/semstr)
+
+