<commit_before>Monguscate
==========

Simple tool for obsfucating ObjectID used by MongoDB

Use this utility to obfuscate ObjectID issued by MongoDB when you use them in your API. It's always a good idea not to
expose anything to the outside world, and this helps you keep your IDs a bit more secure.

## Installation

  ```npm install monguscate --save```

## Usage

  t.b.d.

## Tests

  t.b.d.

## Release History

* 0.1.0 Initial release
<commit_msg>Added some lines to the README.<commit_after>Monguscate
==========

Simple tool for obsfucating ObjectID used by MongoDB

Use this utility to obfuscate ObjectID issued by MongoDB when you use them in your API. It's always a good idea not to
expose anything to the outside world, and this helps you keep your IDs a bit more secure.

## Installation

  ```npm install monguscate --save```

## Usage

  ```
  var obfuscate = require('monguscate').obfuscate
  var x = '54f457292f559f0761000003';   // This is what an ObjectID looks like as a String
  var obfuscated_x = obfuscate(x);
  console.log('ObjectID ', x, 'obfuscated ObjectID', obfuscated_x);
  ```

## Tests

  ```npm test```

## Release History

* 0.1.0 Initial release

{'fraction_non_alphanumeric': 0.09991532599491956, 'fraction_numerical': 0.02286198137171888, 'mean_word_length': 3.884297520661157, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, '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': '275818', 'n_tokens_mistral': 410, 'n_tokens_neox': 369, 'n_words': 155}