<commit_before># node-xmpp

Idiomatic XMPP component library for [node.js](http://nodejs.org/)

[![build status](https://secure.travis-ci.org/node-xmpp/node-xmpp-component.png)](http://travis-ci.org/node-xmpp/node-xmpp-component)

## Manual

Please see http://node-xmpp.github.io/doc/nodexmppcomponent.html for instructions on how to use `node-xmpp-component`.

## Installation

__Note:__ We now only support nodejs versions 0.8.0 and greater.

With package manager [npm](http://npmjs.org/):

    npm install node-xmpp-component

### Testing

Install the dev dependencies, then...

```npm test```

To run the tests and the code style checks then use:

```grunt test```

Also see the tests run in [travis](http://travis-ci.org/node-xmpp/node-xmpp-component). The tests in travis run both the code and code style tests.

## How to use

Please see the various [examples](https://github.com/node-xmpp/node-xmpp/tree/master/examples).

## Objectives of *node-xmpp:*

* Use node.js conventions, especially `EventEmitter`, ie. for write
  buffer control
* Client support for both XMPP clients and components

## Features

* [Component](http://xmpp.org/extensions/xep-0114.html) connections

## Dependencies

* [node-xmpp-core](http://github.com/node-xmpp/node-xmpp-core)

Optional

* [node-stringprep](http://github.com/node-xmpp/node-stringprep): for [icu](http://icu-project.org/)-based string normalization.

# Documentation

(Builing up documentation slowly)

## Component connection

...coming soon...<commit_msg>Remove documention section as its in the manual<commit_after># node-xmpp

Idiomatic XMPP component library for [node.js](http://nodejs.org/)

[![build status](https://secure.travis-ci.org/node-xmpp/node-xmpp-component.png)](http://travis-ci.org/node-xmpp/node-xmpp-component)

## Manual

Please see http://node-xmpp.github.io/doc/nodexmppcomponent.html for instructions on how to use `node-xmpp-component`.

## Installation

__Note:__ We now only support nodejs versions 0.8.0 and greater.

With package manager [npm](http://npmjs.org/):

    npm install node-xmpp-component

### Testing

Install the dev dependencies, then...

```npm test```

To run the tests and the code style checks then use:

```grunt test```

Also see the tests run in [travis](http://travis-ci.org/node-xmpp/node-xmpp-component). The tests in travis run both the code and code style tests.

## How to use

Please see the various [examples](https://github.com/node-xmpp/node-xmpp/tree/master/examples).

## Objectives of *node-xmpp:*

* Use node.js conventions, especially `EventEmitter`, ie. for write
  buffer control
* Client support for both XMPP clients and components

## Features

* [Component](http://xmpp.org/extensions/xep-0114.html) connections

## Dependencies

* [node-xmpp-core](http://github.com/node-xmpp/node-xmpp-core)

Optional

* [node-stringprep](http://github.com/node-xmpp/node-stringprep): for [icu](http://icu-project.org/)-based string normalization.
{'fraction_non_alphanumeric': 0.14425675675675675, 'fraction_numerical': 0.00472972972972973, 'mean_word_length': 4.278074866310161, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 4, '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': '5022630', 'n_tokens_mistral': 1040, 'n_tokens_neox': 1002, 'n_words': 253}