diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 17 |
1 files changed, 15 insertions, 2 deletions
@@ -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/<uid>/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/<uid>/karlender`. + +### Websocket + +Packets are text messages. Default bind address is `127.0.0.1:18752`. |