From 0992071a7f1a36424bcfaf1fbc84541ea041df1a Mon Sep 17 00:00:00 2001 From: hozan23 Date: Thu, 11 Apr 2024 10:19:20 +0200 Subject: add support for tokio & improve net crate api --- p2p/README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'p2p/README.md') diff --git a/p2p/README.md b/p2p/README.md index e00d9e5..768fd19 100644 --- a/p2p/README.md +++ b/p2p/README.md @@ -1,6 +1,6 @@ # karyon p2p -karyon p2p serves as the foundational stack for the karyon project. It offers +karyon p2p serves as the foundational stack for the Karyon project. It offers a lightweight, extensible, and customizable peer-to-peer (p2p) network stack that seamlessly integrates with any p2p project. @@ -130,7 +130,14 @@ boolean `enable_tls` field in the configuration. However, implementing TLS for a P2P network is not trivial and is still unstable, requiring a comprehensive audit. -## Usage + +## 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. + +## Examples You can check out the examples [here](./examples). -- cgit v1.2.3