Merge pull request #3 from xxshady/patch-3

feat: add readme
altmp · Feb 25, 2024 · 2d024e2 · 2d024e2
2 parents a2a260f + 2127a8d
commit 2d024e2
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"
+}
+```