<commit_before><commit_msg>doc(readme): add a little readme<commit_after><p align="center">
  <h1>node-flydrive</h1>
</p>

<p align="center">
  <a href="https://www.npmjs.com/package/node-flydrive"><img src="https://img.shields.io/npm/v/node-flydrive.svg?style=flat-square" alt="Version"></a>
  <a href="https://www.npmjs.com/package/node-flydrive"><img src="https://img.shields.io/npm/dt/node-flydrive.svg?style=flat-square" alt="Downloads"></a>
  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/npm/l/node-flydrive.svg?style=flat-square" alt="License"></a>
</p>

<br>

`node-flydrive` is a framework-agnostic package which provides a powerful wrapper to manage Storage in [Node.js](https://nodejs.org).<br>

> :pray: This package is under active development, some breaking changes may occur before the first release.

<br>
<hr>
<br>

## Table of Contents

 * [Getting Started](#getting-started)
 * [Contribution Guidelines](#contribution-guidelines)
 * [Change Logs](#change-logs)

<br>
## Getting Started

This package is available in the Node Package Repository.<br>
It can easily be installed with `npm`.

```bash
$ npm i --save node-flydrive
```

When you require the package in your file, it will give you access to the `StorageManager` class.<br>
This class is a facade for the package and should be instantiated with a [configuration object](https://github.com/Slynova-Org/node-flydrive/blob/master/tests/stubs/config.js).
<br>

```javascript
const StorageManager = require('node-flydrive')
const storage = new StorageManager(config)

// Note that we are using co to run this code.
// @see https://github.com/tj/co
co(function* () {
  // Use the default disk.
  const file = yield storage.get('storage/logs.txt')
  console.log(file.toString())

  // Specify wich disk you want to use.
  const file = yield storage.disk('local').get('storage/logs.txt')
  console.log(file.toString())
})
```

<br>
## Contribution Guidelines

Any pull requests or discussions are welcome.<br>
Note that every pull request providing new feature or correcting a bug should be created with appropriate unit tests.
<br>
## Change Logs

Nothing will be wrote here before the release of the first version.
{'fraction_non_alphanumeric': 0.1463963963963964, 'fraction_numerical': 0.0009009009009009009, 'mean_word_length': 4.680306905370844, 'pattern_counts': {'":': 0, '<': 30, '<?xml version=': 0, '>': 31, 'https://': 9, 'lorem ipsum': 0, 'www.': 2, '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': '999019', 'n_tokens_mistral': 720, 'n_tokens_neox': 687, 'n_words': 211}