<commit_before>
# monk

Monk is a tiny layer that provides simple yet substantial usability
improvements for MongoDB usage within Node.JS.

## Features

- Command buffering. You can start querying right away.
- Promises built-in for all queries. Easy interoperability with modules.
- Easy connections / configuration
- Well-designed signatures
- Improvements to the MongoDB APIs (eg: `findAndModify` supports the
  `update` signature style)
- Auto-casting of `_id` in queries
- Builds on top of [mongoskin](http://github.com/guileen/node-mongoskin)

## How to use

### Connecting<commit_msg>Added short example.<commit_after>
# monk

Monk is a tiny layer that provides simple yet substantial usability
improvements for MongoDB usage within Node.JS.

```js
var db = require('monk')('localhost/mydb')
  , users = db.get('users')

users.index('name last');
users.insert({ name: 'Tobi', bigdata: {} });
users.find({ name: 'Loki' }, '-bigdata', function () {
  // exclude bigdata field
});
```

## Features

- Command buffering. You can start querying right away.
- Promises built-in for all queries. Easy interoperability with modules.
- Easy connections / configuration
- Well-designed signatures
- Improvements to the MongoDB APIs (eg: `findAndModify` supports the
  `update` signature style)
- Auto-casting of `_id` in queries
- Builds on top of [mongoskin](http://github.com/guileen/node-mongoskin)

## How to use

### Connecting
{'fraction_non_alphanumeric': 0.1112666200139958, 'fraction_numerical': 0.0, 'mean_word_length': 4.355805243445693, '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': '545547', 'n_tokens_mistral': 442, 'n_tokens_neox': 417, 'n_words': 157}