From 004d3d9f18f2aedadfaf188b60a16d0c16d6ee5e Mon Sep 17 00:00:00 2001
From: Simon Kellet <sik00038@students.stir.ac.uk>
Date: Mon, 6 Jul 2026 15:18:49 +0100
Subject: [PATCH] readme

---
 README.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/README.md b/README.md
index e69de29..0d84167 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,18 @@
+# Go-like flags in Odin
+
+This a very simple implementation of Go-like flags in Odin
+
+## Usage
+
+```odin
+	defer myflag.destroy()
+	isRunning: bool
+	isNumber: int
+	isString: string
+
+	myflag.BoolVar(&isRunning, "isRunning", true, "A select piece of code is running!")
+	myflag.IntVar(&isNumber, "isNumber", 3434, "A number!")
+	myflag.StringVar(&isString, "isString", "Hellope!", "A string!")
+
+	myflag.parse_flags()
+```
\ No newline at end of file