<commit_before># friends-irc

[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]

[npm-image]: https://img.shields.io/npm/v/friends-irc.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/friends-irc
[travis-image]: https://img.shields.io/travis/moose-team/friends-irc.svg?style=flat-square
[travis-url]: https://travis-ci.org/moose-team/friends-irc

Connects IRC and Friends channels by sending messages back and forth.
Based on [slack-irc](https://github.com/ekmartin/slack-irc).

## Installation and usage
Use the newest version of io.js and npm (`>= 1.8.1`, `>= 2.8.3`) and follow the [prerequisite steps](https://github.com/js-platform/node-webrtc#prerequisites)
for [node-webrtc](https://github.com/js-platform/node-webrtc) before continuing.

Install either through npm:
```bash
$ npm install -g friends-irc
$ friends-irc --config /path/to/config.json
```

or by cloning the repository:
```bash
In the repository folder:
$ npm install
$ node index.js --config /path/to/config.json
```

## Configuration
friends-irc requires a JSON-configuration file, where path can be given either through
the CLI-option `--config` or the environment variable `CONFIG_FILE`. The configuration
file needs to be an object or an array, depending on the number of IRC bots you want to run.<commit_msg>Set travis badge to show the master branch<commit_after># friends-irc

[![npm][npm-image]][npm-url]
[![travis][travis-image]][travis-url]

[npm-image]: https://img.shields.io/npm/v/friends-irc.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/friends-irc
[travis-image]: https://img.shields.io/travis/moose-team/friends-irc/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/moose-team/friends-irc

Connects IRC and Friends channels by sending messages back and forth.
Based on [slack-irc](https://github.com/ekmartin/slack-irc).

## Installation and usage
Use the newest version of io.js and npm (`>= 1.8.1`, `>= 2.8.3`) and follow the [prerequisite steps](https://github.com/js-platform/node-webrtc#prerequisites)
for [node-webrtc](https://github.com/js-platform/node-webrtc) before continuing.

Install either through npm:
```bash
$ npm install -g friends-irc
$ friends-irc --config /path/to/config.json
```

or by cloning the repository:
```bash
In the repository folder:
$ npm install
$ node index.js --config /path/to/config.json
```

## Configuration
friends-irc requires a JSON-configuration file, where path can be given either through
the CLI-option `--config` or the environment variable `CONFIG_FILE`. The configuration
file needs to be an object or an array, depending on the number of IRC bots you want to run.
{'fraction_non_alphanumeric': 0.1474118529632408, 'fraction_numerical': 0.00450112528132033, 'mean_word_length': 4.6147368421052635, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 7, 'https://': 14, 'lorem ipsum': 0, 'www.': 2, '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': '6971692', 'n_tokens_mistral': 947, 'n_tokens_neox': 871, 'n_words': 244}