From 6301d7d9c63eb960d3820e507c188fb872944e7c Mon Sep 17 00:00:00 2001 From: Mitchell McKenna Date: Tue, 17 Jun 2014 17:56:42 -0700 Subject: [PATCH] Update Readme; multiple file() needs custom key - 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 --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c0b6815..ec8680f 100644 --- a/README.md +++ b/README.md @@ -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'); @@ -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');