<commit_before># Viae

A bi-directional communication api framework with streaming support. 

![363886-200](https://cloud.githubusercontent.com/assets/3584509/22102513/a04d0904-de2f-11e6-9591-ebfa2516ea07.png)

[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-downloads]][npm-url]
[![Travis Status][travis-image]][travis-url]
[![codecov](https://codecov.io/gh/MeirionHughes/viae/branch/master/graph/badge.svg)](https://codecov.io/gh/MeirionHughes/viae)
[![Stability][stability-image]][stability-url]

## install

* `npm install viae` 

## Usage

check [Documentation](https://github.com/MeirionHughes/viae/wiki) for more examples; 

### WebSocket - Client

```ts
const WebSocket = require('ws'); // or browser
const Via = require('viae').Via;

let ws = new WebSocket("ws://localhost:8080", "viae");
let via = new Via(ws);

```

### WebSocket - Server

```ts
const WebSocketServer = require('ws').Server;
const Viae = require('viae').Viae;

let wss = new WebSocketServer({ port: 8080, handleProtocols: ["viae"] });
let server = new Viae(wss);
```

## Build

```
npm install
npm test
```

## Credits
"Cross" Icon courtesy of [The Noun Project](https://thenounproject.com/), by [<NAME>](https://thenounproject.com/sandorsz/), under [CC 3.0](http://creativecommons.org/licenses/by/3.0/us/)

[npm-url]: https://npmjs.org/package/viae
[npm-image]: http://img.shields.io/npm/v/viae.svg
[npm-downloads]: http://img.shields.io/npm/dm/viae.svg
[travis-url]: https://travis-ci.org/MeirionHughes/viae
[travis-image]: https://img.shields.io/travis/MeirionHughes/viae/master.svg
[stability-image]: https://img.shields.io/badge/stability-1%20%3A%20unstable-red.svg
[stability-url]: https://nodejs.org/api/documentation.html#documentation_stability_index<commit_msg>doc: remove bad example<commit_after># Viae

A bi-directional communication api framework with streaming support. 

![363886-200](https://cloud.githubusercontent.com/assets/3584509/22102513/a04d0904-de2f-11e6-9591-ebfa2516ea07.png)

[![NPM version][npm-image]][npm-url]
[![NPM downloads][npm-downloads]][npm-url]
[![Travis Status][travis-image]][travis-url]
[![codecov](https://codecov.io/gh/MeirionHughes/viae/branch/master/graph/badge.svg)](https://codecov.io/gh/MeirionHughes/viae)
[![Stability][stability-image]][stability-url]

## install

* `npm install viae` 

## Usage

check [Documentation](https://github.com/MeirionHughes/viae/wiki) for more examples; 

### WebSocket - Client

```ts
const WebSocket = require('ws'); // or browser
const Via = require('viae').Via;

let ws = new WebSocket("ws://localhost:8080");
let via = new Via(ws);

```

### WebSocket - Server

```ts
const WebSocketServer = require('ws').Server;
const Viae = require('viae').Viae;

let wss = new WebSocketServer({ port: 8080 });
let server = new Viae(wss);
```

## Build

```
npm install
npm test
```

## Credits
"Cross" Icon courtesy of [The Noun Project](https://thenounproject.com/), by [<NAME>](https://thenounproject.com/sandorsz/), under [CC 3.0](http://creativecommons.org/licenses/by/3.0/us/)

[npm-url]: https://npmjs.org/package/viae
[npm-image]: http://img.shields.io/npm/v/viae.svg
[npm-downloads]: http://img.shields.io/npm/dm/viae.svg
[travis-url]: https://travis-ci.org/MeirionHughes/viae
[travis-image]: https://img.shields.io/travis/MeirionHughes/viae/master.svg
[stability-image]: https://img.shields.io/badge/stability-1%20%3A%20unstable-red.svg
[stability-url]: https://nodejs.org/api/documentation.html#documentation_stability_index
{'fraction_non_alphanumeric': 0.192274678111588, 'fraction_numerical': 0.03547925608011445, 'mean_word_length': 5.276481149012567, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 22, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 6, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6972842', 'n_tokens_mistral': 1454, 'n_tokens_neox': 1311, 'n_words': 203}