From fa6cd0a06d1a2ade56d7eb17e18372461353b842 Mon Sep 17 00:00:00 2001
From: Martin Donnelly <martin.donnelly@aiber.co.uk>
Date: Fri, 16 Feb 2024 11:19:04 +0000
Subject: [PATCH] added readme

---
 readme.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..35938dd
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,24 @@
+# Go Password
+
+
+A password generator written in Go as a test, replaces the old node based password generator
+
+
+
+To build:
+
+```shell
+
+ $ go build -ldflags "-s -w"
+ 
+```
+
+This will build a smaller executable, then do:
+
+```shell
+
+ $ sudo cp password /usr/bin/password-gen
+
+```
+
+To copy it into the executable store
\ No newline at end of file