From 97629ecb9e4723e5b30b08e757ac3478f9a8746a Mon Sep 17 00:00:00 2001 From: hozan23 Date: Mon, 20 May 2024 01:12:06 +0200 Subject: minor updates README.md --- README.md | 18 +++++++++--------- p2p/README.md | 6 +++--- 2 files changed, 12 insertions(+), 12 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 diff --git a/p2p/README.md b/p2p/README.md index 768fd19..02c4742 100644 --- a/p2p/README.md +++ b/p2p/README.md @@ -133,9 +133,9 @@ audit. ## Choosing the async runtime -karyon p2p currently supports 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. +karyon p2p currently supports 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. ## Examples -- cgit v1.2.3