1
0
mirror of https://github.com/oceanprotocol-archive/squid-js.git synced 2024-02-02 15:31:51 +01:00

add documentation section, update TOC

This commit is contained in:
Matthias Kretschmann 2019-01-30 17:37:23 +01:00 committed by Pedro Gutiérrez
parent 3cf578cfae
commit 25284a3e2d

View File

@ -18,11 +18,11 @@
--- ---
## Table of Contents
- [Get started](#get-started) - [Get started](#get-started)
- [Examples](#examples) - [Examples](#examples)
- [Documentation](#documentation)
- [Development](#development) - [Development](#development)
- [Testing](#testing)
- [Production build](#production-build) - [Production build](#production-build)
- [npm releases](#npm-releases) - [npm releases](#npm-releases)
- [License](#license) - [License](#license)
@ -75,6 +75,10 @@ const ocean: Ocean = await Ocean.getInstance({
* [Examples](/src/examples/) * [Examples](/src/examples/)
* [Tuna](https://github.com/oceanprotocol/tuna/examples/squid) * [Tuna](https://github.com/oceanprotocol/tuna/examples/squid)
## Documentation
* [Docs: squid-js API Reference](https://docs.oceanprotocol.com/references/squid-js/)
## Development ## Development
To start development you need to: To start development you need to:
@ -84,7 +88,7 @@ npm i
npm start npm start
``` ```
### Test ### Testing
To start unit tests you need to: To start unit tests you need to: