diff options
| author | hozan23 <hozan23@proton.me> | 2023-11-22 21:48:09 +0300 |
|---|---|---|
| committer | hozan23 <hozan23@proton.me> | 2023-11-22 21:48:09 +0300 |
| commit | d4c8251ea3c4f6e809bb19f8faa907083316f483 (patch) | |
| tree | 5b2409cb338f4c1f46029b27c94f0bcfe5b02fec /README.md | |
| parent | 34b0a91dbb107962dae4f593a36d30a29ea87c45 (diff) | |
add Docs section to README.md file & add an example to p2p crate
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 9 insertions, 1 deletions
@@ -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, |