diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..5a53ef3
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,10 @@
+# self hosted qr code generator
+just run compose file, port is 7123
+
+## current functionality
+
+- [x] URLs
+- [x] Telephone
+- [x] Email
+- [x] (partial) WiFi 
+- [ ] VCard (contact info in a QR code)