Skip to content

Commit cd086b3

Browse files
committed
Add link and instructions to obtain typedoc docs
1 parent e079906 commit cd086b3

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

cardano-wasm/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,16 @@ To work around that, disable build concurrency:
253253
wasm32-wasi-cabal build cardano-wasm -j1 --ghc-options="-j1" --no-semaphore
254254
```
255255

256+
# Documentation
257+
258+
You can find the generated typedoc documentation for the version of `cardano-wasm` in `master` branch [here](https://cardano-api.cardano.intersectmbo.org/cardano-wasm/typedoc/).
259+
260+
Or you can generate it using nix by writing:
261+
262+
```bash
263+
nix build .#wasm-typedoc
264+
```
265+
256266
# Examples
257267

258268
You can find examples of how to use the `cardano-wasm` library in the [examples](./examples) subfolder.

0 commit comments

Comments
 (0)