aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorhozan23 <hozan23@proton.me>2023-11-22 23:25:20 +0300
committerhozan23 <hozan23@proton.me>2023-11-22 23:25:20 +0300
commiteaa0c2bd4d59c8c90027604d718de96ca4b34f9e (patch)
treeadc9a1d2ad9702d38aea85b01416422f95c6415e
parent8981f3d12bb8dd699254371da356d5a441f0a630 (diff)
README: add online docs in docs section
-rw-r--r--.github/workflows/docs.yml3
-rw-r--r--README.md12
2 files changed, 9 insertions, 6 deletions
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 6711231..318375a 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -3,11 +3,10 @@ name: Build and Deploy Rust API Docs
on:
push:
branches:
- - test-ci-docs
+ - main
jobs:
docs:
- name: build karyons rust api docs
runs-on: ubuntu-latest
permissions:
contents: write
diff --git a/README.md b/README.md
index 0e2bd97..185e066 100644
--- a/README.md
+++ b/README.md
@@ -31,11 +31,15 @@ including TLS implementation. You can check the
## Docs
-To generate karyons Rust API Documentation, run the following command:
+Online documentation for the main crates:
-```bash
-$ cargo doc --no-deps --all --document-private-items --open
-```
+- [karyons_p2p](https://karyons.github.io/karyons/karyons_p2p)
+- [karyons_jsonrpc](https://karyons.github.io/karyons/karyons_jsonrpc)
+
+For the internal crates:
+
+- [karyons_core](https://karyons.github.io/karyons/karyons_core)
+- [karyons_net](https://karyons.github.io/karyons/karyons_net)
## Thanks