Add package doc comment

2023-06-22 14:42:16 -07:00
parent 1a31c082d9
commit 0b2b067575
2 changed files with 2 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,2 +0,0 @@
-# vercmp
-
--- a/vercmp.go
+++ b/vercmp.go
@@ -1,3 +1,5 @@
+// Package vercmp provides comparison between two arbitrary version strings.
+// It uses a modified implementation of the rpmvercmp algorithm used by the RPM package manager.
 package vercmp

 import (