From e8032b255edc277a69d410558ec32ff118944b16 Mon Sep 17 00:00:00 2001 From: metamuffin Date: Thu, 18 Aug 2022 09:15:00 +0200 Subject: Expand readme for new transport methods --- karld/src/interface/websocket.rs | 2 +- readme.md | 13 ++++++------- 2 files changed, 7 insertions(+), 8 deletions(-) diff --git a/karld/src/interface/websocket.rs b/karld/src/interface/websocket.rs index e983e06..da7d918 100644 --- a/karld/src/interface/websocket.rs +++ b/karld/src/interface/websocket.rs @@ -52,7 +52,7 @@ fn handle_connection(stream: Result) -> anyhow::Resul } Err(tungstenite::Error::Io(e)) if let std::io::ErrorKind::WouldBlock = e.kind() => { - // its fine^ + // its fine } Err(e) => Err(e)?, } diff --git a/readme.md b/readme.md index 6af0ef6..8750096 100644 --- a/readme.md +++ b/readme.md @@ -21,13 +21,12 @@ A bloated calender software. 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`. +| Transport | Note | Default location/address | +| ------------------ | -------------------------- | ---------------------------- | +| Unix domain socket | Every line is a packet. | `/run/user//karlender`. | +| Websocket | Packets are text messages. | `127.0.0.1:18752`. | +| TCP | Every line is a packet | `127.0.0.1:18751`. | +| Stdio | Every line is a packet | stdin / stdout | ## Licence -- cgit v1.2.3-70-g09d2