# Overview

## ![](https://github.com/buccaneerai/rxws/raw/master/docs/rxws.png)

[![CircleCI](https://circleci.com/gh/buccaneerai/rxws/tree/master.svg?style=shield)](https://circleci.com/gh/buccaneerai/rxws/tree/master) [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)  [![](https://img.shields.io/npm/v/@buccaneer/rxws.svg)](https://www.npmjs.com/package/@buccaneer/rxws)

## Overview

This package is a simple, reliable, isomorphic, expressive, two-way WebSocket client built with [RxJS 6](https://rxjs-dev.firebaseapp.com) and [socket.io](https://socket.io).

### Documentation

* [Basic Usage](https://brianbuccaneer.gitbook.io/rxws/guides/gettingstarted)
* [Guides](https://brianbuccaneer.gitbook.io/rxws/guides)
* [API Docs](https://brianbuccaneer.gitbook.io/rxws/api)

### Installation

```bash
npm i @buccaneer/rxws --save
```

```bash
yarn add @buccaneer/rxws
```

### Compatibility

| Platform        | Support |
| --------------- | :-----: |
| node.js (>10.8) |    ✅    |
| Browsers        |    ✅    |
| React Native    |    ✅    |
| Electron        |    ✅    |

### Community

Do you like `rxws`? Here's how you can help make it better:

* Star us [on Github](https://github.com/buccaneerai/rxws) ✨ :octocat: ✨
* [Become a contributor (even small contributions matter!)](https://github.com/buccaneerai/rxws/blob/master/CONTRIBUTING.md) 👑
* [Are we missing the operator or feature you need? Make a pull request to add it!](https://github.com/buccaneerai/rxws/blob/master/CONTRIBUTING.md) 🤦&#x20;
* Report & Debug Issues [on GitHub](https://github.com/buccaneerai/rxws) 🌊

### License

MIT
