Skip to content

Commit

Permalink
[fix] filename --> file in a few file transport examples
Browse files Browse the repository at this point in the history
  • Loading branch information
jfhbrook authored and indexzero committed Oct 22, 2011
1 parent 2e33082 commit d8a3020
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

``` js
nconf.add('global', { type: 'file', filename: '/path/to/globalconf.json' });
nconf.add('userconf', { type: 'file', filename: '/path/to/userconf.json' });
nconf.add('global', { type: 'file', file: '/path/to/globalconf.json' });
nconf.add('userconf', { type: 'file', file: '/path/to/userconf.json' });
```

### nconf.use(name, options)
Expand All @@ -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
//
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
//
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)
Expand Down Expand Up @@ -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)

[0]: http://github.com/indexzero/nconf
[0]: http://github.com/indexzero/nconf

0 comments on commit d8a3020

Please sign in to comment.