feat: add readme

altmp · Feb 22, 2024 · 2127a8d · 2127a8d
1 parent a2a260f
commit 2127a8d
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md 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"
+}
+```