TheThing/nconf-lite
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

[fix] filename --> file in a few file transport examples

Browse source
This commit is contained in:
Joshua Holbrook 2011-10-20 13:54:47 -07:00 committed by indexzero
parent 2e33082f0b
commit d8a30203ce
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -59,8 +59,8 @@ The top-level of `nconf` is an instance of the `nconf.Provider` abstracts this a
Adds a new store with the specified `name` and `options`. If `options.type` is not set, then `name` will be used instead: Adds a new store with the specified `name` and `options`. If `options.type` is not set, then `name` will be used instead:
``` js ``` js
nconf.add('global', { type: 'file', filename: '/path/to/globalconf.json' }); nconf.add('global', { type: 'file', file: '/path/to/globalconf.json' });
nconf.add('userconf', { type: 'file', filename: '/path/to/userconf.json' }); nconf.add('userconf', { type: 'file', file: '/path/to/userconf.json' });
``` ```
### nconf.use(name, options) ### nconf.use(name, options)
@ -70,12 +70,12 @@ Similar to `nconf.add`, except that it can replace an existing store if new opti
// //
// Load a file store onto nconf with the specified settings // Load a file store onto nconf with the specified settings
// //
nconf.use('file', { filename: '/path/to/some/config-file.json' }); nconf.use('file', { file: '/path/to/some/config-file.json' });
// //
// Replace the file store with new settings // Replace the file store with new settings
// //
nconf.use('file', { filename: 'path/to/a-new/config-file.json' }); nconf.use('file', { file: 'path/to/a-new/config-file.json' });
``` ```
### nconf.remove(name) ### nconf.remove(name)
@ -186,4 +186,4 @@ Tests are written in vows and give complete coverage of all APIs and storage eng
#### Author: [Charlie Robbins](http://nodejitsu.com) #### Author: [Charlie Robbins](http://nodejitsu.com)
[0]: http://github.com/indexzero/nconf [0]: http://github.com/indexzero/nconf