<commit_before># node-crossyio-unpack
crossy.io npm module unpacker

[![Build Status](https://travis-ci.org/crossyio/node-crossyio-unpack.svg?branch=master)](https://travis-ci.org/crossyio/node-crossyio-unpack)
[![Code Climate](https://codeclimate.com/github/crossyio/node-crossyio-unpack/badges/gpa.svg)](https://codeclimate.com/github/crossyio/node-crossyio-unpack)
[![Gitter](https://badges.gitter.im/crossyio/chat.svg)](https://gitter.im/crossyio/chat)<commit_msg>add readme info<commit_after># crossyio-unpack
crossy.io npm module unpacker

[![Build Status](https://travis-ci.org/crossyio/node-crossyio-unpack.svg?branch=master)](https://travis-ci.org/crossyio/node-crossyio-unpack)
[![Code Climate](https://codeclimate.com/github/crossyio/node-crossyio-unpack/badges/gpa.svg)](https://codeclimate.com/github/crossyio/node-crossyio-unpack)
[![Gitter](https://badges.gitter.im/crossyio/chat.svg)](https://gitter.im/crossyio/chat)

Crossy.IO allows you to easily cross compile your NPM packages for multiple operating systems / architectures. Sign up at [crossy.io](https://crossy.io).

## Usage

Include the following in your `package.json`.

```json
{
  "scripts": {
    "preinstall": "node node_modules/crossyio-unpack/preinstall.js; exit 0"
  },
  "bundledDependencies": [
    "crossyio-unpack"
  ],
  "dependencies": {
    "crossyio-unpack": "^1.0.0"
  },
  "crossyio": {
    "url": "crossy.io/org-name/package-name"
  }
}
```

When someone installs your package, the preinstall script will check `crossy.io` and, if available, download a tarball containing the package dependencies. The tarball will be extracted into your node_modules.

If the pre-compiled version is not available, the normal npm process will continue.

## Example

See [crossyio-canary](https://github.com/crossyio/node-crossyio-canary) as an example npm package.
{'fraction_non_alphanumeric': 0.1563517915309446, 'fraction_numerical': 0.002171552660152009, 'mean_word_length': 4.983766233766234, 'pattern_counts': {'":': 7, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 14, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 1, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3414283', 'n_tokens_mistral': 669, 'n_tokens_neox': 648, 'n_words': 114}