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"
+}
+```