From 5de5373aff72ccfb780331d62b7ef9fd5024c65c Mon Sep 17 00:00:00 2001
From: illyum <itzillyum@gmail.com>
Date: Tue, 3 Sep 2024 22:17:00 -0600
Subject: [PATCH] Update README.md

---
 README.md | 38 +++++++++++++++++++++++++++++++++++++-
 1 file changed, 37 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index d12251b..e8c8eef 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,37 @@
-Just a little for mmaker tool (not safe!!!)
\ No newline at end of file
+# Just a little for mmaker tool (not safe!!!)
+
+### Pages:
+- / | Place to fill out answers
+- /manage | Place to manage questions
+- /admin | Place to view submited answers
+
+## Cloning the repo:
+clone with
+```bash
+http://proudcircle.xyz/illyum/FormMaker.git
+```
+cd into the `FormMaker` folder.
+
+Run
+```bash
+go mod tidy
+```
+Then you can either use
+```bash
+go build .
+```
+to build the binary.
+
+\- or -
+```bash
+go run .
+```
+to run the app (This will also produce a binary in a hiden file on your system)
+
+### Limitations:
+- Text answers only (ASCI)
+- No account authorization (ANYONE can view /admin & /manage)
+
+
+#### Storage
+The site uses an sqlite database in the folder of the app (will be automatically generated). Answers and questions will both be written to this database.
\ No newline at end of file