From edcab64df59a8c95f49c7957139f980dd5269e95 Mon Sep 17 00:00:00 2001
From: Lucas Barbieri <lucasbarbieri.c@gmail.com>
Date: Mon, 19 Aug 2024 13:01:23 -0300
Subject: [PATCH] feat: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2d26d69
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# abyss
+abyss is a basic http server made for uploading images and then sharing them to the internet
+
+note: this is a project made for learning purposes, you should use other more mature projects if running in production
+
+## running:
+- edit consts in `main.go` to match your needs. (for example, on my server, change `$url` so that the response will be nicely formatted)
+
+- to run it, either build with `go build -o abyss` or run it directly with:
+```
+go run ./main.go
+```
+## todo:
+- add upload of logs funcionality (like 0x0.st)
+- add docker easy setup