aboutsummaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <yvchraiqi@protonmail.com>2022-08-16 16:16:26 +0200
committermetamuffin <yvchraiqi@protonmail.com>2022-08-16 16:16:26 +0200
commit1b46514ab7c9c54e635fdfc1e561ab14da512537 (patch)
tree0b025c3b3e0720ad4ec6ca70e5f998669523920f /readme.md
parentea35ce0e6848c1224fa4c1cff424480a2996b49a (diff)
downloadkarlender-1b46514ab7c9c54e635fdfc1e561ab14da512537.tar
karlender-1b46514ab7c9c54e635fdfc1e561ab14da512537.tar.bz2
karlender-1b46514ab7c9c54e635fdfc1e561ab14da512537.tar.zst
doc
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`