From 2b33bb65d3838d7facadad9fe4bb6a6365805c59 Mon Sep 17 00:00:00 2001 From: Matthias Kretschmann Date: Wed, 30 Jan 2019 17:46:14 +0100 Subject: [PATCH] mention local typedoc generation --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0a30382..ff47327 100644 --- a/README.md +++ b/README.md @@ -77,7 +77,14 @@ const ocean: Ocean = await Ocean.getInstance({ ## Documentation -* [Docs: squid-js API Reference](https://docs.oceanprotocol.com/references/squid-js/) +* **[Docs: squid-js API Reference](https://docs.oceanprotocol.com/references/squid-js/)** + +Alternatively, you can generate the raw TypeDoc documentation locally by running: + +```bash +# will output to ./doc folder +npm run doc +``` ## Development