From 1b46514ab7c9c54e635fdfc1e561ab14da512537 Mon Sep 17 00:00:00 2001
From: metamuffin <yvchraiqi@protonmail.com>
Date: Tue, 16 Aug 2022 16:16:26 +0200
Subject: doc

---
 COPYING               | 2 +-
 karlcommon/src/lib.rs | 2 +-
 readme.md             | 9 +++++++++
 3 files changed, 11 insertions(+), 2 deletions(-)
 create mode 100644 readme.md

diff --git a/COPYING b/COPYING
index 42262b3..b659085 100644
--- a/COPYING
+++ b/COPYING
@@ -1,4 +1,4 @@
-karlender (karld, karlc) - bloated calendar daemon
+karlender (karld, karlc, karlgui, libkarlcommon) - bloated calendar daemon
 Copyright (C) 2022 metamuffin
 
 This program is free software: you can redistribute it and/or modify
diff --git a/karlcommon/src/lib.rs b/karlcommon/src/lib.rs
index 173beba..f9cd9d4 100644
--- a/karlcommon/src/lib.rs
+++ b/karlcommon/src/lib.rs
@@ -10,7 +10,7 @@ pub fn socket_path() -> PathBuf {
     std::env::var("XDG_RUNTIME_DIR")
         .map(|p| Path::new(p.as_str()).to_path_buf())
         .unwrap_or_else(|_| Path::new("/run/user").join(format!("{}", getuid())))
-        .join("calendar")
+        .join("karlender")
 }
 fn getuid() -> u32 {
     std::fs::metadata("/proc/self").unwrap().uid()
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`
-- 
cgit v1.2.3-70-g09d2