From e8dcf261a3dfc8f6bec4016cb32010d8682a1915 Mon Sep 17 00:00:00 2001 From: metamuffin Date: Wed, 17 Aug 2022 19:34:56 +0200 Subject: update readme bc new if --- readme.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) (limited to 'readme.md') diff --git a/readme.md b/readme.md index 6cff481..1dc56e6 100644 --- a/readme.md +++ b/readme.md @@ -2,8 +2,21 @@ A bloated calender software. -TODO +## Features + +- flexible condition-based recurring tasks +- automatic scheduling of tasks, based on priority +- blazing fast and highly configurable 🚀🚀 +- undocumented ## Protocol -Every line sent over the unix domain socket, is a JSON-serialized instance of either `ServerboundPacket` or `ClientboundPacket` respectively as declared in ([karlcommon/protocol.d.ts](./karlcommon/protocol.d.ts)). By default the socket is located at `/run/user//karlender` +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. + +### Unix domain socket + +Every line is a packet. Default location for the socket is `/run/user//karlender`. + +### Websocket + +Packets are text messages. Default bind address is `127.0.0.1:18752`. -- cgit v1.2.3-70-g09d2