improve README
This commit is contained in:
parent
0256166c2f
commit
37d81fa4c6
29
README.md
29
README.md
@ -1,13 +1,36 @@
|
||||
# smartfile
|
||||
make files easily accessible for processing in javascript.
|
||||
|
||||
## Status
|
||||
## 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://codecov.io/github/pushrocks/smartfile?branch=master)
|
||||
[](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.
|
||||
It can fetch files from remote locations, work with local disks and do pure memory operations.
|
||||
|
||||
### 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 more information read the docs
|
||||
|
||||
[](https://push.rocks)
|
||||
|
Loading…
x
Reference in New Issue
Block a user