oceanprotocol
/
squid-js
mirror of https://github.com/oceanprotocol-archive/squid-js.git
1
0
Fork 0
Code Releases Activity

mention local typedoc generation

This commit is contained in:
Matthias Kretschmann 2019-01-30 17:46:14 +01:00 committed by Pedro Gutiérrez
parent e86fd04453
commit 2b33bb65d3
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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