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

Commit ab27b92

Browse files
committed
docs(readme): review suggestion readme refactoring
1 parent 8806e74 commit ab27b92

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,21 @@
77
Streamr JavaScript Client
88
</h1>
99

10-
By using this client, you can easily interact with the [Streamr](https://streamr.network) API from JavaScript-based environments, such as browsers and [node.js](https://nodejs.org). You can, for example, subscribe to real-time data in streams, produce new data to streams, and create new streams.
10+
By using this client, you can easily interact with the [Streamr](https://streamr.network) API from JavaScript-based environments, such as browsers and [node.js](https://nodejs.org). You can, for example, subscribe to real-time data in streams, produce new data to streams, and create new streams. The client uses websockets for producing and consuming messages to/from streams. It should work in all modern browsers.
1111

12-
The client uses websockets for producing and consuming messages to/from streams. It should work in all modern browsers.
13-
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:
12+
Please see the [API Docs](https://streamr-dev.github.io/streamr-client-javascript/) for more detailed documentation.
1713

18-
```
19-
npm run docs
20-
```
14+
[![Build Status](https://travis-ci.com/streamr-dev/streamr-client-javascript.svg?branch=master)](https://travis-ci.com/streamr-dev/streamr-client-javascript)
2115

2216
### Breaking changes notice
2317

2418
* Date TBD: Support for unsigned data will be dropped.
2519

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-
2820
----
2921

3022
## TOC
3123

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](#stream-partitioning) · [Logging](#logging) · [NPM Publishing](#publishing-latest)
24+
[Installation](#installation) · [Usage](#usage) · [API Docs](#API-docs) · [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](#stream-partitioning) · [Logging](#logging) · [NPM Publishing](#publishing-latest)
3325

3426

3527
## Installation
@@ -139,6 +131,14 @@ await stream.publish(msg)
139131

140132
----
141133

134+
## API Docs
135+
136+
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:
137+
138+
```
139+
npm run docs
140+
```
141+
142142
## Client options
143143

144144
| Option | Default value | Description |

0 commit comments

Comments
 (0)