aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorhozan23 <hozan23@karyontech.net>2024-05-20 01:12:06 +0200
committerhozan23 <hozan23@karyontech.net>2024-05-20 01:12:06 +0200
commit97629ecb9e4723e5b30b08e757ac3478f9a8746a (patch)
treeb139a884c8ab15d1f0428c2538ad967eb1f0a1e3 /README.md
parent1836034374ba53677f5b72bdf8e3c976f97847af (diff)
minor updates README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/README.md b/README.md
index 38be1a3..c179efc 100644
--- a/README.md
+++ b/README.md
@@ -24,22 +24,22 @@ efficient for developers everywhere.
## Crates
-- [karyon core](./core): Essential utilities and core functionality.
-- [karyon net](./net): Provides a network interface for TCP, UDP, WebSocket, and Unix,
+- **[karyon core](./core)**: Essential utilities and core functionality.
+- **[karyon net](./net)**: Provides a network interface for TCP, UDP, TLS, WebSocket, and Unix,
along with common network functionality.
-- [karyon p2p](./p2p): A lightweight, extensible, and customizable
+- **[karyon p2p](./p2p)**: A lightweight, extensible, and customizable
peer-to-peer (p2p) network stack.
-- [karyon jsonrpc](./jsonrpc): A fast and small async
+- **[karyon jsonrpc](./jsonrpc)**: A fast and lightweight async
[JSONRPC2.0](https://www.jsonrpc.org/specification) implementation.
-- karyon crdt: A [CRDT](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type)
+- **karyon crdt**: A [CRDT](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type)
implementation for building collaborative software.
-- karyon base: A lightweight, extensible database that operates with `karyon crdt`.
+- **karyon base**: A lightweight, extensible database that operates with `karyon crdt`.
## Choosing the async runtime
-All the crates support both smol(async-std) and tokio. The default is smol, but
-if you want to use tokio, you need to disable the default features and then
-select the `tokio` feature.
+All the crates support both **smol(async-std)** and **tokio** async runtimes.
+The default is **smol**, but if you want to use **tokio**, you need to disable
+the default features and then select the `tokio` feature.
## Docs