<commit_before><commit_msg>README.md added<commit_after>My Node Package
=====
[![Build Status](https://travis-ci.org/s0ber/npm-template.png?branch=master)](https://travis-ci.org/s0ber/npm-template)

## Usage

### Basic preparation

Clone this repo, rename it, remove git files. Install **gulp** and **coffeegulp** to easily run gulp tasks defined within ```gulp.coffee```.

```
cd ~/my_projects
git clone <EMAIL>:s0ber/npm-template.git
mv npm-template my_awesome_package
cd my_awesome_package
rm -rf .git

npm install -g gulp
npm install -g coffeegulp
npm install
```

Edit ```package.json``` with required data.

### Testing

Run specs in development mode (all file changes will be watched).

```
coffeegulp mocha:dev
```

You can also sync your TravisCI account and turn on builds for your repo.

### Releasing

If you want to release a new version of your package, at first, edit ```package.json```, then perform the following task.

```
coffeegulp release
```

It will at first run your specs. If they'll pass, compiled versions of your source files will be created in **lib/** folder.


### Source files

You should list your source files in ```gulpfile.coffee```, gulp will use them for building compiled versions, and mocha will use them for running specs.

### License

Don't forget to edit LICENSE file before the release.

{'fraction_non_alphanumeric': 0.11411411411411411, 'fraction_numerical': 0.0022522522522522522, 'mean_word_length': 4.577405857740586, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 2, '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': '1932626', 'n_tokens_mistral': 426, 'n_tokens_neox': 400, 'n_words': 166}