Skip to content

Commit 90230b3

Browse files
committed
Adds .travis.yml, updates README
1 parent ead1695 commit 90230b3

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
branches:
2+
only:
3+
- master
4+
language: node_js
5+
node_js:
6+
- "4.3"

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# parse-server-fs-adapter
22
parse-server file system storage adapter
3+
4+
5+
# installation
6+
7+
`npm install --save parse-server-fs-adapter`
8+
9+
# usage with parse-server
10+
11+
### using a config file
12+
13+
```
14+
{
15+
"appId": 'my_app_id',
16+
"masterKey": 'my_master_key',
17+
// other options
18+
"filesAdapter": {
19+
"module": "parse-server-fs-adapter",
20+
"options": {
21+
"filesSubDirectory": "my/files/folder" // optional
22+
}
23+
}
24+
}
25+
```
26+
27+
### passing as an instance
28+
29+
```
30+
var FSFilesAdapter = require('parse-server-fs-adapter');
31+
32+
var fsAdapter = new FSFilesAdapter({
33+
"filesSubDirectory": "my/files/folder" // optional
34+
});
35+
36+
var api = new ParseServer({
37+
appId: 'my_app',
38+
masterKey: 'master_key',
39+
filesAdapter: fsAdapter
40+
})
41+
```
42+

0 commit comments

Comments
 (0)