<commit_before>OS Metrics
==========
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Middleware plugin which collects OS metrics.


## Installation

For use in Node.js,

``` bash
$ npm install monitor-plugin-os
```

## Usage





## Notes





## Tests

### Unit

Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:<commit_msg>[UPDATE] README.<commit_after>OS Metrics
==========
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependencies][dependencies-image]][dependencies-url]

> Middleware plugin which collects OS metrics.


## Installation

``` bash
$ npm install monitor-plugin-os
```

## Usage

To use the module,

``` javascript
var plugin = require( 'monitor-plugin-os' );
```

The module exports the following method...


#### plugin( obj, clbk )

Appends system metrics to an `object` and then invokes the provided callback.

``` javascript
plugin( {}, function next() {});
```


## Examples

``` javascript
var plugin = require( 'monitor-plugin-os' );

// Initialize a monitor object:
var monitor = {};

// Run the plugin:
plugin( monitor, function next() {
	console.log( JSON.stringify( monitor ) );
});
```

To run the example code from the top-level application directory,

``` bash
$ node ./examples/index.js
```


## Notes

Note that the plugin will append a `system` property to the provided `object`. If a `system` property already exists, the property `value` will be overwritten.



## Tests

### Unit

Unit tests use the [Mocha](http://visionmedia.github.io/mocha) test framework with [Chai](http://chaijs.<EMAIL>) assertions. To run the tests, execute the following command in the top-level application directory:
{'fraction_non_alphanumeric': 0.15680473372781065, 'fraction_numerical': 0.0, 'mean_word_length': 4.813753581661891, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 6, 'https://': 0, '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': '7089488', 'n_tokens_mistral': 651, 'n_tokens_neox': 589, 'n_words': 192}