<commit_before># Most Proxy

Simple way to create circular dependencies without the use of subjects.

## Example

```js
import {periodic} from 'most'
import {proxy} from 'most-proxy'

// create a proxy
// returns fn to attach proxy to another stream, and a proxy stream
const [attach, actionProxy$] = proxy()

// observe the proxy, taking only three events
// proxy is a real most.Stream
// when actionProxy$ ends, original will also be disposed of internally
actionProxy$.take(3).observe(x => console.log(x)) // 1, 2, 3

// here we create the stream we want to use as the circular dep 
const original = peridioc(100).scan((x, y) => x + y, 0)

// pipe events from original to proxy stream
attach(original)
```
<commit_msg>docs(README): update readme with a little info<commit_after># Most Proxy

Simple way to create circular dependencies without the use of subjects.

## Install
```shell
$ npm install --save most-proxy
```

## API Documentation

Documentation can be found [here](https://tylors.github.io/most-proxy/docs)

## Example

```js
import {periodic} from 'most'
import {proxy} from 'most-proxy'

// create a proxy
// returns fn to attach proxy to another stream, and a proxy stream
const [attach, actionProxy$] = proxy()

// observe the proxy, taking only three events
// proxy is a real most.Stream
// when actionProxy$ ends, original will also be disposed of internally
actionProxy$.take(3).observe(x => console.log(x)) // 1, 2, 3

// here we create the stream we want to use as the circular dep
const original = peridioc(100).scan((x, y) => x + y, 0)

// pipe events from original to proxy stream
attach(original)
```

{'fraction_non_alphanumeric': 0.11458333333333333, 'fraction_numerical': 0.00980392156862745, 'mean_word_length': 4.040123456790123, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 1, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5719038', 'n_tokens_mistral': 496, 'n_tokens_neox': 470, 'n_words': 215}