From 2127a8d6b6b028e311955b0805d1f19d8e6259e3 Mon Sep 17 00:00:00 2001
From: xshady <54737754+xxshady@users.noreply.github.com>
Date: Fri, 23 Feb 2024 00:20:32 +0300
Subject: [PATCH] feat: add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1758427
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# url-shortener
+
+alt:V link shortener, for example: https://go.altv.mp/trouble
+
+## Namespaces
+Namespaces are constructed via `-`, so for example this link can be opened via https://go.altv.mp/js-docs
+```json
+"js": {
+    "docs": "https://docs.altv.mp/js/index.html"
+}
+```