diff options
| author | hozan23 <hozan23@karyontech.net> | 2024-04-11 10:19:20 +0200 |
|---|---|---|
| committer | hozan23 <hozan23@karyontech.net> | 2024-05-19 13:51:30 +0200 |
| commit | 0992071a7f1a36424bcfaf1fbc84541ea041df1a (patch) | |
| tree | 961d73218af672797d49f899289bef295bc56493 /p2p/README.md | |
| parent | a69917ecd8272a4946cfd12c75bf8f8c075b0e50 (diff) | |
add support for tokio & improve net crate api
Diffstat (limited to 'p2p/README.md')
| -rw-r--r-- | p2p/README.md | 11 |
1 files changed, 9 insertions, 2 deletions
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). |