From d4c8251ea3c4f6e809bb19f8faa907083316f483 Mon Sep 17 00:00:00 2001 From: hozan23 Date: Wed, 22 Nov 2023 21:48:09 +0300 Subject: add Docs section to README.md file & add an example to p2p crate --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) (limited to 'README.md') diff --git a/README.md b/README.md index 28b2ddc..0e2bd97 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ Join us on: along with common network functionality. - [karyons p2p](./p2p): A lightweight, extensible, and customizable peer-to-peer (p2p) network stack. -- [karyons jsonrpc](./jsonrpc): A fast and lightweight async +- [karyons jsonrpc](./jsonrpc): A fast and small async [JSONRPC2.0](https://www.jsonrpc.org/specification) implementation. - karyons crdt: A [CRDT](https://en.wikipedia.org/wiki/Conflict-free_replicated_data_type) implementation for building collaborative software. @@ -29,6 +29,14 @@ crdt and karyons store, along with major changes to the network stack, including TLS implementation. You can check the [issues](https://github.com/karyons/karyons/issues) for updates on ongoing tasks. +## Docs + +To generate karyons Rust API Documentation, run the following command: + +```bash +$ cargo doc --no-deps --all --document-private-items --open +``` + ## Thanks Big thanks to [Ink & Switch](https://www.inkandswitch.com/) team, -- cgit v1.2.3