From b68232653a084853df13a314314ab06810eba7d2 Mon Sep 17 00:00:00 2001 From: sergeych Date: Sun, 11 Aug 2024 16:31:08 +0200 Subject: [PATCH] readme docs --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c8f3f98..7f0a73c 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,17 @@ While UDP is faster than TCP/IP, it is less reliable, especially with commands a ## Websock server -While it is much slower than pure TCP, it is still faster than any http-based transport. It uses binary frames based on +While it is much slower than TCP or UDP, it is still faster than any http-based API; it uses binary frames based on the Ktor server framework to easily integrate with web services. We recommend using it instead of a classic HTTP API as it beats it in terms of speed and server load even with HTTP/2. We recommend to create the `KiloInterface` instance and connect it to the websock and tcp servers in real applications to get easy access from anywhere. +## Websocket client + +It is slower than TCP or UDP, but it works on literally all platforms. See the sample below. + # Usage The library should be used as maven dependency, not as source.