Skip to content

Commit d4bef16

Browse files
committed
docs: update readme
1 parent b94144d commit d4bef16

File tree

1 file changed

+21
-10
lines changed

1 file changed

+21
-10
lines changed

README.md

Lines changed: 21 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
## Under Development
2-
3-
**This branch is a work in progress rewrite of rsocket-js from [Flow](https://flow.org/) to [TypeScript](https://www.typescriptlang.org/). Please see [#158](https://github.com/rsocket/rsocket-js/issues/158).**
4-
5-
**You SHOULD NOT leverage any artifacts published from this branch as all are considered unstable.**
6-
7-
**Please see the [master](https://github.com/rsocket/rsocket-js/tree/master) branch for source used to publish the latest `0.x.x` versions on NPM.**
8-
91
# [rsocket-js](https://github.com/rsocket/rsocket-js)
102

113
[![Build](https://github.com/rsocket/rsocket-js/actions/workflows/build.yml/badge.svg?branch=1.0.x)](https://github.com/rsocket/rsocket-js/actions/workflows/build.yml)
@@ -26,9 +18,28 @@ protocol intended for use in browsers and/or Node.js. From [rsocket.io](http://r
2618
> - event subscription (infinite stream of many)
2719
> - channel (bi-directional streams)
2820
29-
## Install
21+
## Status
22+
23+
This branch contains a rewrite (with significant changes) of rsocket-js from [Flow](https://flow.org/) to [TypeScript](https://www.typescriptlang.org/). Please see [#158](https://github.com/rsocket/rsocket-js/issues/158) for additional details.
24+
25+
The artifacts published from this branch are considered UNSTABLE and may be subject to breaking changes while in preview.
26+
27+
**Please see the [master](https://github.com/rsocket/rsocket-js/tree/master) branch for sources related to `0.x.x` versions.**
28+
29+
## Installation
30+
31+
Individual packages published from this monorepo are distributed via NPM.
32+
33+
Packages are independently versioned.
3034

31-
TODO: add install instructions
35+
- [rsocket-core](https://www.npmjs.com/package/rsocket-core)
36+
- [rsocket-messaging](https://www.npmjs.com/package/rsocket-messaging)
37+
- [rsocket-composite-metadata](https://www.npmjs.com/package/rsocket-composite-metadata)
38+
- [rsocket-tcp-client](https://www.npmjs.com/package/rsocket-tcp-client)
39+
- [rsocket-tcp-server](https://www.npmjs.com/package/rsocket-tcp-server)
40+
- [rsocket-websocket-client](https://www.npmjs.com/package/rsocket-websocket-client)
41+
- [rsocket-websocket-server](https://www.npmjs.com/package/rsocket-websocket-server)
42+
- [rsocket-adapter-rxjs](https://www.npmjs.com/package/rsocket-adapter-rxjs)
3243

3344
## Contributing
3445

0 commit comments

Comments
 (0)