aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..94c2d53
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,9 @@
+# karlender
+
+A bloated calender software.
+
+TODO
+
+## Protocol
+
+Every line sent over the unix domain socket, is a JSON-serialized instance of either `ServerboundPacket` or `ClientboundPacket` as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)). By default the socket is located at `/run/user/<uid>/karlender`