smartfile/docs/index.md

# smartfile

make files easily accessible for processing in javascript.

## Availabililty

[![npm](https://pushrocks.gitlab.io/assets/repo-button-npm.svg)](https://www.npmjs.com/package/smartfile)
[![git](https://pushrocks.gitlab.io/assets/repo-button-git.svg)](https://gitlab.com/pushrocks/smartfile)
[![git](https://pushrocks.gitlab.io/assets/repo-button-mirror.svg)](https://github.com/pushrocks/smartfile)
[![docs](https://pushrocks.gitlab.io/assets/repo-button-docs.svg)](https://pushrocks.gitlab.io/smartfile/)

## Status for master

[![build status](https://gitlab.com/pushrocks/smartfile/badges/master/build.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartfile/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartfile/commits/master)
[![Dependency Status](https://david-dm.org/pushrocks/smartfile.svg)](https://david-dm.org/pushrocks/smartfile)
[![bitHound Dependencies](https://www.bithound.io/github/pushrocks/smartfile/badges/dependencies.svg)](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
[![bitHound Code](https://www.bithound.io/github/pushrocks/smartfile/badges/code.svg)](https://www.bithound.io/github/pushrocks/smartfile)
[![TypeScript](https://img.shields.io/badge/TypeScript-2.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![node](https://img.shields.io/badge/node->=%206.x.x-blue.svg)](https://nodejs.org/dist/latest-v6.x/docs/api/)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com/)

## Usage

smartfile is an approach of being one tool to handle files in diverse environments.

### Smartfile Sections

smartfile thinks in sections:

| section     | description                                                                  |
| ----------- | ---------------------------------------------------------------------------- |
| fs          | (object) gets data from fs to somewhere                                      |
| memory      | gets data from memory to somewhere                                           |
| remote      | gets data from remote locations to somewhere                                 |
| interpreter | (object) handles yaml and json                                               |
| smartfile   | (class) a virtual representation of a file, alternative to vinyl file format |

For further information read the linked docs at the top of this README.

> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

[![npm](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://push.rocks)