chore: Include API in readme (#409)

eigerco · Oct 3, 2024 · 37f9a4d · 37f9a4d
1 parent 6fee3ed
commit 37f9a4d
Show file tree

Hide file tree

Showing 6 changed files with 1,420 additions and 2 deletions.
diff --git a/node-wasm/README.md b/node-wasm/README.md
@@ -40,3 +40,8 @@ const client = await new NodeClient(channel.port2);
 await client.waitConnected();
 await client.requestHeadHeader();
 ```
+
+## Rust API
+
+For comprehensive and fully typed interface documentation, see [lumina-node](https://docs.rs/lumina-node/latest/lumina_node/) and [celestia-types](https://docs.rs/celestia-types/latest/celestia_types/) documentation on docs.rs. You can see there the exact structure of more complex types, such as [`ExtendedHeader`](https://docs.rs/celestia-types/latest/celestia_types/struct.ExtendedHeader.html). JavaScript API's goal is to provide similar interface to Rust when possible, e.g. `NodeClient` mirrors [`Node`](https://docs.rs/lumina-node/latest/lumina_node/node/struct.Node.html).
+
diff --git a/node-wasm/js/.gitignore b/node-wasm/js/.gitignore
@@ -1,2 +1,3 @@
 /node_modules
 /package-lock.json
+/docs
diff --git a/node-wasm/js/README.md b/node-wasm/js/README.md