Skip to content
This repository was archived by the owner on Dec 21, 2021. It is now read-only.

Commit 5306be0

Browse files
authored
Update README.md
1 parent 02bb8ef commit 5306be0

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ The client uses websockets for producing and consuming messages to/from streams.
1313

1414
[![Build Status](https://travis-ci.com/streamr-dev/streamr-client-javascript.svg?branch=master)](https://travis-ci.com/streamr-dev/streamr-client-javascript)
1515

16-
[API Docs](https://streamr-dev.github.io/streamr-client-javascript/)
17-
1816
### Breaking changes notice
1917

2018
* Date TBD: Support for unsigned data will be dropped.
@@ -23,7 +21,7 @@ The client uses websockets for producing and consuming messages to/from streams.
2321

2422
## TOC
2523

26-
[Installation](#installation) · [Usage](#usage) · [Client options](#client-options) · [Authentication options](#authentication-options) · [Message handler callback](#message-handler-callback) · [StreamrClient object](#streamrclient-object) · [Stream object](#stream-object) · [Subscription options](#subscription-options) · [Data Unions](#data-unions) · [Utility functions](#utility-functions) · [Events](#binding-to-events) · [Partitioning](#partitioning) · [Logging](#logging) · [NPM Publishing](#publishing-latest)
24+
[Installation](#installation) · [Usage](#usage) · [API Docs](#api-docs) · [Client options](#client-options) · [Authentication options](#authentication-options) · [Message handler callback](#message-handler-callback) · [StreamrClient object](#streamrclient-object) · [Stream object](#stream-object) · [Subscription options](#subscription-options) · [Data Unions](#data-unions) · [Utility functions](#utility-functions) · [Events](#binding-to-events) · [Partitioning](#partitioning) · [Logging](#logging) · [NPM Publishing](#publishing-latest)
2725

2826

2927
## Installation
@@ -36,6 +34,14 @@ npm install streamr-client
3634

3735
Node v14 or higher is recommended if you intend to use the client in a Node environment. For example, inside a script.
3836

37+
## API Docs
38+
39+
We have automatically generated API documentation available [here](https://streamr-dev.github.io/streamr-client-javascript/). These docs are generated from the repository TypeScript source code. They can also be rebuilt locally via:
40+
41+
```
42+
npm run docs
43+
```
44+
3945
## Usage
4046

4147
Here are some quick examples. More detailed examples for the browser and node.js can be found [here](https://github.com/streamr-dev/streamr-client/tree/master/examples).

0 commit comments

Comments
 (0)