Skip to content

Commit

Permalink
Update Readme; multiple file() needs custom key
Browse files Browse the repository at this point in the history
- Update the Readme with notes that when using multiple config files,
  the user must use a custom key as the first parameter in additional
  nconf.file() calls in order for config heirarchy/inheritance to work
  properly.

Fixes #97, Fixes #109, Fixes #110
  • Loading branch information
MitchellMcKenna committed Jun 18, 2014
1 parent 8105c76 commit 6301d7d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Expand Up @@ -92,6 +92,7 @@ A sane default for this could be:

//
// Or with a custom name
// Note: A custom key must be supplied for hierarchy to work if multiple files are used.
//
nconf.file('custom', '/path/to/config.json');

Expand Down Expand Up @@ -209,7 +210,7 @@ Loads a given object literal into the configuration hierarchy. Both `nconf.defau
```

### File
Based on the Memory store, but provides additional methods `.save()` and `.load()` which allow you to read your configuration to and from file. As with the Memory store, all method calls are synchronous with the exception of `.save()` and `.load()` which take callback functions. It is important to note that setting keys in the File engine will not be persisted to disk until a call to `.save()` is made.
Based on the Memory store, but provides additional methods `.save()` and `.load()` which allow you to read your configuration to and from file. As with the Memory store, all method calls are synchronous with the exception of `.save()` and `.load()` which take callback functions. It is important to note that setting keys in the File engine will not be persisted to disk until a call to `.save()` is made. Note a custom key must be supplied as the first parameter for hierarchy to work if multiple files are used.

``` js
nconf.file('path/to/your/config.json');
Expand Down

0 comments on commit 6301d7d

Please sign in to comment.