<commit_before># dependument

[![Build Status](https://travis-ci.org/Jameskmonger/dependument.svg?branch=typescript)](https://travis-ci.org/Jameskmonger/dependument)
[![npm version](https://badge.fury.io/js/dependument.svg)](https://badge.fury.io/js/dependument)
[![Dependency status](https://david-dm.org/jameskmonger/dependument/status.png)](https://david-dm.org/jameskmonger/dependument#info=dependencies&view=table)
[![Dev Dependency Status](https://david-dm.org/jameskmonger/dependument/dev-status.png)](https://david-dm.org/jameskmonger/dependument#info=devDependencies&view=table)
[![license](https://img.shields.io/badge/license-unlicense-blue.svg)](http://shields.io/)

Dependument is an open-source, lightweight tool for automatically documenting the dependencies associated with your project.

## Setup
To install dependument, simply run the following command to install the [npm package](https://www.npmjs.com/package/dependument).

    $ npm install -g dependument

### Why does it need global installation?
Dependument needs to be installed globally (with the `-g` argument) so that you can run it from the command line.

## Usage
To use dependument, first navigate to your project folder with your terminal.

Then, run the following command:

    $ dependument

A markdown file called `DEPENDENCIES.md` will be generated displaying some information about your dependencies and the developer dependencies from your `package.json`.

## Licence
Dependument is (un)licensed under [The Unlicense](http://unlicense.org/). Do what you like with it.<commit_msg>Update dependency status badge<commit_after># dependument

[![Build Status](https://travis-ci.org/Jameskmonger/dependument.svg?branch=typescript)](https://travis-ci.org/Jameskmonger/dependument)
[![npm version](https://badge.fury.io/js/dependument.svg)](https://badge.fury.io/js/dependument)
[![Dependency status](https://david-dm.org/dependument/dependument/status.png)](https://david-dm.org/dependument/dependument#info=dependencies&view=table)
[![Dev Dependency Status](https://david-dm.org/jameskmonger/dependument/dev-status.png)](https://david-dm.org/jameskmonger/dependument#info=devDependencies&view=table)
[![license](https://img.shields.io/badge/license-unlicense-blue.svg)](http://shields.io/)

Dependument is an open-source, lightweight tool for automatically documenting the dependencies associated with your project.

## Setup
To install dependument, simply run the following command to install the [npm package](https://www.npmjs.com/package/dependument).

    $ npm install -g dependument

### Why does it need global installation?
Dependument needs to be installed globally (with the `-g` argument) so that you can run it from the command line.

## Usage
To use dependument, first navigate to your project folder with your terminal.

Then, run the following command:

    $ dependument

A markdown file called `DEPENDENCIES.md` will be generated displaying some information about your dependencies and the developer dependencies from your `package.json`.

## Licence
Dependument is (un)licensed under [The Unlicense](http://unlicense.org/). Do what you like with it.
{'fraction_non_alphanumeric': 0.1244049508092669, 'fraction_numerical': 0.0, 'mean_word_length': 5.594142259414226, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 20, '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': '6899859', 'n_tokens_mistral': 950, 'n_tokens_neox': 904, 'n_words': 250}