aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 9 insertions, 1 deletions
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,