Skip to content

Commit fdf289e

Browse files
committed
docs: update docs
remove `options.directory` from docs add cli flags to rc file docs
1 parent 1ec38b6 commit fdf289e

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ npm install mongodb-backup-cron --save
2929

3030
## Usage
3131

32+
#### The mongo dump file is initially created in the operating system's temp directory using `OS.tmpdir()`
33+
3234
### CLI Usage
3335

3436
```
@@ -83,7 +85,6 @@ const options = {
8385
accessKeyId: 'key',
8486
secretAccessKey: 'secret',
8587
bucket: 'backup.mongo',
86-
directory: __dirname,
8788
retry: 3,
8889
schedule: '0 0,12 * * *',
8990
start: true, // used to specify if cron should start once created
@@ -94,13 +95,14 @@ const options = {
9495
### Configuration Files
9596

9697
Create [an rc file][rc] to set defaults, so you don't have to pass an
97-
`accessKeyId` and `secretAccessKey` flag to every command.
98+
`uri`, `accessKeyId`, `secretAccessKey`, `retry`, and `bucket` flag to every command.
9899

99100
```
100101
# ~/.mongodb-backuprc
101102
uri = mongodb://localhost:27017/database
102103
accessKeyId = key
103104
secretAccessKey = secret
105+
retry = 3
104106
bucket = bucket
105107
```
106108

@@ -113,6 +115,6 @@ context aware.
113115
[MIT © Jeremiah Harlan.](LICENSE)
114116

115117
[rc]: https://www.npmjs.com/package/rc
116-
[version]: https://www.npmjs.com/package/s3-mongodump
117-
[build]: https://travis-ci.org/theworkflow/s3-mongodump
118-
[license]: https://raw.githubusercontent.com/theworkflow/s3-mongodump/master/LICENSE
118+
[version]: https://www.npmjs.com/package/mongodb-backup-cron
119+
[build]: https://travis-ci.org/theworkflow/mongodb-backup-cron
120+
[license]: https://raw.githubusercontent.com/theworkflow/mongodb-backup-cron/master/LICENSE

0 commit comments

Comments
 (0)