SergeychWorks/kiloparsec
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 6 Wiki Activity

readme docs

Browse Source
This commit is contained in:
Sergey Chernov 2024-08-11 16:31:08 +02:00
parent 2e4f551e8e
commit b68232653a
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -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<S>` 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.