[![CircleCI](https://circleci.com/gh/buccaneerai/bottlenose/tree/master.svg?style=shield)](https://circleci.com/gh/buccaneerai/bottlenose/tree/master)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
<a href="https://www.npmjs.com/package/@bottlenose/rxfs">
  <img src="https://img.shields.io/npm/v/@bottlenose/rxfs.svg" alt="Version">
</a>

## Description
`@bottlenose/rxfs` is part of the [Bottlenose](https://github.com/buccaneerai/bottlenose) project.  It is a simple, lightweight package which makes it easy to read files from the local filesystem into RxJS Observables.  It also supports writing and appending Observables into files.

## Installation
```bash
npm i @bottlenose/rxfs --save
```
Or...
```bash
yarn add @bottlenose/rxfs
```

## Compatability

| Platform | Support |
| :--- | :--- |
| node.js \(&gt;10.0\) | ✅ |
| Browsers | ❌ |
| React Native | ❌ |
| Electron | ❌ |

## Documentation & Guides
- [Documentation & Guides](https://buccaneerai.gitbook.io/bottlenose/sources-and-sinks/rxs3)