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

readme formatting

Browse Source
This commit is contained in:
Sergey Chernov 2025-11-02 14:13:47 +01:00
parent 6dc246e68c
commit fe4cb2ca21
1 changed files with 12 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -8,14 +8,14 @@ The new generation of __PARanoid SECurity__ protocol, advanced, faster, more sec
block device" transport to the same local interface. Out if the box it block device" transport to the same local interface. Out if the box it
provides the following transports: provides the following transports:
| name | JVM | JS | wasmJS | native | | name | JVM | JS | wasmJS | native |
|-------------------|--------|----|--------|--------| |-------------------|:----:|:---:|:-------:|:------:|
| TCP/IP server | ✓ | | | 0.2.6+ | | TCP/IP server | ✓ | | | ✓ |
| TCP/IP client | ✓ | | | 0.2.6+ | | TCP/IP client | ✓ | | | ✓ |
| UDP server | 0.3.2+ | | | 0.3.2+ | | UDP server | ✓ | | | ✓ |
| UDP client | 0.3.2+ | | | 0.3.2+ | | UDP client | ✓ | | | ✓ |
| Websockets server | ✓ | | | | | Websockets server | ✓ | | | |
| Websockets client | ✓ | ✓ | ✓ | ✓ | | Websockets client | ✓ | ✓ | ✓ | ✓ |
### Note on version compatibility ### Note on version compatibility
@ -149,7 +149,8 @@ assertEquals(FooArgs("bar", 117), client.call(cmdGetFoo))
## Create a ktor-based server ## Create a ktor-based server
Normally the server side needs some session. It is convenient and avoids sending repeating data on each request speeding up Normally the server side needs some session. It is convenient and avoids sending repeating data on each request speeding
up
the protocol. With KILOPARSEC, it is a rather basic operation: the protocol. With KILOPARSEC, it is a rather basic operation:
~~~kotlin ~~~kotlin
@ -287,7 +288,8 @@ Integrated tools to prevent MITM attacks include also non-transferred independen
independently on the ends and is never transferred with the network. Comparing it somehow (visually, with QR code, etc.) independently on the ends and is never transferred with the network. Comparing it somehow (visually, with QR code, etc.)
could add a very robust guarantee of the connection safety and ingenuity. could add a very robust guarantee of the connection safety and ingenuity.
Kiloparsec has a built-in completely asynchronous (coroutine-based top-down) transport layer based on TCP (JVM only as for Kiloparsec has a built-in completely asynchronous (coroutine-based top-down) transport layer based on TCP (JVM only as
for
now) and the same async Websocket-based transport based on KTOR. Websocket client is multiplatform, though the server is now) and the same async Websocket-based transport based on KTOR. Websocket client is multiplatform, though the server is
JVM only insofar. JVM only insofar.