From bf83c875529304e2b66867e5d902ed8b4adea611 Mon Sep 17 00:00:00 2001
From: baalajimaestro <me@baalajimaestro.me>
Date: Sun, 7 May 2023 22:43:00 +0530
Subject: [PATCH] Add a basic readme

Signed-off-by: baalajimaestro <me@baalajimaestro.me>
---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6689ae2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,10 @@
+# Obsolute Paste
+
+A no-nonsense pastebin, that serves content of files from a private gitlab repository
+
+Necessary ENV Variables:
+
+`GITLAB_TOKEN`: A personal/deploy token, that can read the files in the provided repo
+`BASE_URL`: Base API URL to the repo, example: `https://git.baalajimaestro.me/api/v4/projects/0`
+
+This project is hostable with docker, and a prebuilt docker image is at `registry.baalajimaestro.me/baalajimaestro/obsolute-paste`