From c170fd46b32da6af9ca18621b30d2316434c1557 Mon Sep 17 00:00:00 2001
From: Foil-hat-guy <dev@foilhatguy.casa>
Date: Sun, 20 Apr 2025 12:13:03 +0300
Subject: [PATCH] README.md file is added.

---
 README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c7cfc0e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+### The "Version" package
+=============
+This package provides --version flag feature to your cli.
+It recognize both short and long flags. Version number is
+automatically added from the latest tag in your git repo.
+-------------
+### Usage
+1. Download the package by **go get** command:
+```shell
+go get code.foilhatguy.casa/pub/version
+```
+2. Add the package as a tool dependency to your project,
+tools.go:
+```go
+// +build tools
+
+package tools
+
+import (
+	_ "code.foilhatguy.casa/pub/version"
+)
+```
+3. In the main package add a go:generate directive:
+```go
+//go:generate go run code.foilhatguy.casa/pub/version
+```
+4. Run code generator by **go generate** command: 
+```shell
+go generate ./...
+```
+The package will detect a version number from the latest git
+tag from your project. Then it will generate a **version.go** 
+file as a part of the main package. It will contain a version
+number as a constant and code for --version flag detection.
+5. Build and run your application with the --version flag.
+```shell
+go run . --version
+```
\ No newline at end of file