From e87219d47764f82d073f464a23aa18a6f7d0c9d3 Mon Sep 17 00:00:00 2001 From: metamuffin Date: Wed, 17 Aug 2022 20:51:09 +0200 Subject: expand readme --- readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/readme.md b/readme.md index 1dc56e6..6af0ef6 100644 --- a/readme.md +++ b/readme.md @@ -9,6 +9,14 @@ A bloated calender software. - blazing fast and highly configurable 🚀🚀 - undocumented +## Components + +- `karld` daemon process calculating occurences and scheduling +- `karlc` cli-interface for karld (uses unix domain socket) +- `karlgui` graphical user interface made with egui (uses the unix domain socket too) +- `karlcommon` rust library for shared e.g. protocol +- _`????`_ browser interface (future, will use websocket) + ## Protocol Packets with JSON-serialized instances of either `ServerboundPacket` or `ClientboundPacket` respectively as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)) are sent over one of the supported methods. @@ -20,3 +28,7 @@ Every line is a packet. Default location for the socket is `/run/user//karl ### Websocket Packets are text messages. Default bind address is `127.0.0.1:18752`. + +## Licence + +GNU Affero General Public License Version 3 only. See [COPYING](./COPYING) -- cgit v1.2.3-70-g09d2