39 lines
2.2 KiB
Markdown
39 lines
2.2 KiB
Markdown
# smartfile
|
|
make files easily accessible for processing in javascript.
|
|
|
|
## Availabililty
|
|
[](https://www.npmjs.com/package/smartfile)
|
|
[](https://gitlab.com/pushrocks/smartfile)
|
|
[](https://github.com/pushrocks/smartfile)
|
|
[](https://pushrocks.gitlab.io/smartfile/)
|
|
|
|
## Status for master
|
|
[](https://gitlab.com/pushrocks/smartfile/commits/master)
|
|
[](https://gitlab.com/pushrocks/smartfile/commits/master)
|
|
[](https://david-dm.org/pushrocks/smartfile)
|
|
[](https://www.bithound.io/github/pushrocks/smartfile/master/dependencies/npm)
|
|
[](https://www.bithound.io/github/pushrocks/smartfile)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](https://nodejs.org/dist/latest-v6.x/docs/api/)
|
|
[](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)
|
|
|
|
[](https://push.rocks)
|