From 0b2b067575c46aee5f70413e0ab295f973d509ba Mon Sep 17 00:00:00 2001
From: Elara Musayelyan <elara@elara.ws>
Date: Thu, 22 Jun 2023 14:42:16 -0700
Subject: [PATCH] Add package doc comment

---
 README.md | 2 --
 vercmp.go | 2 ++
 2 files changed, 2 insertions(+), 2 deletions(-)
 delete mode 100644 README.md

diff --git a/README.md b/README.md
deleted file mode 100644
index d211fdb..0000000
--- a/README.md
+++ /dev/null
@@ -1,2 +0,0 @@
-# vercmp
-
diff --git a/vercmp.go b/vercmp.go
index 580f9a3..4cffc18 100644
--- 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 (