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

Commit 5613e96

Browse files
authored
Readme tidyup
docs(readme): API Docs more prominent, fixed broken TOC links
1 parent dcb9ab2 commit 5613e96

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,17 +11,25 @@ By using this client, you can easily interact with the [Streamr](https://streamr
1111

1212
The client uses websockets for producing and consuming messages to/from streams. It should work in all modern browsers.
1313

14-
[![Build Status](https://travis-ci.com/streamr-dev/streamr-client-javascript.svg?branch=master)](https://travis-ci.com/streamr-dev/streamr-client-javascript)
14+
### API Docs
15+
16+
The [API docs](https://streamr-dev.github.io/streamr-client-javascript/) are automatically generated from the TypeScript source code. They can also be rebuilt locally via:
17+
18+
```
19+
npm run docs
20+
```
1521

1622
### Breaking changes notice
1723

1824
* Date TBD: Support for unsigned data will be dropped.
1925

26+
[![Build Status](https://travis-ci.com/streamr-dev/streamr-client-javascript.svg?branch=master)](https://travis-ci.com/streamr-dev/streamr-client-javascript)
27+
2028
----
2129

2230
## TOC
2331

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)
32+
[API Docs](#API-docs) · [Installation](#installation) · [Usage](#usage) · [Client options](#client-options) · [Authentication](#authentication) · [Managing subscriptions](#managing-subscriptions) · [Stream API](#stream-api) · [Subscription options](#subscription-options) · [Data Unions](#data-unions) · [Utility functions](#utility-functions) · [Events](#events) · [Stream Partitioning](#streamr-partitioning) · [Logging](#logging) · [NPM Publishing](#publishing-latest)
2533

2634

2735
## Installation
@@ -34,14 +42,6 @@ npm install streamr-client
3442

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

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-
4545
## Usage
4646

4747
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).
@@ -139,10 +139,6 @@ await stream.publish(msg)
139139

140140
----
141141

142-
# Docs
143-
144-
Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascript/) for auto-generated documentation.
145-
146142
## Client options
147143

148144
| Option | Default value | Description |
@@ -163,9 +159,7 @@ Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascrip
163159

164160
## Authentication options
165161

166-
Note: **Authenticating with an API key has been deprecated.**
167-
168-
Note: **Support for email/password authentication will be dropped in the future and cryptographic keys/wallets will be the only supported method.**
162+
Note: **Authenticating with an API key has been deprecated. Cryptographic keys/wallets is the only supported authentication method.**
169163

170164
If you don't have an Ethereum account you can use the utility function `StreamrClient.generateEthereumAccount()`, which returns the address and private key of a fresh Ethereum account.
171165

@@ -347,7 +341,7 @@ All the below functions return a Promise which gets resolved with the result.
347341

348342
## Data Unions
349343

350-
This library provides functions for working with Data Unions.
344+
This library provides functions for working with Data Unions. Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascript/) for auto-generated documentation on each Data Union endpoint.
351345

352346
To deploy a new DataUnion:
353347
```js
@@ -510,7 +504,7 @@ client.on('connected', () => {
510504
| resent | [ResendResponseResent](https://github.com/streamr-dev/streamr-client-protocol-js/blob/master/src/protocol/control_layer/resend_response_resent/ResendResponseResentV1.js) | Fired after `resending` when the subscription has finished resending and message has been processed |
511505
| error | Error object | Reports errors, for example problems with message content |
512506

513-
## Partitioning
507+
## Stream Partitioning
514508

515509
Partitioning (sharding) enables streams to scale horizontally. This section describes how to use partitioned streams via this library. To learn the basics of partitioning, see [the docs](https://streamr.network/docs/streams#partitioning).
516510

0 commit comments

Comments
 (0)