Skip to content

Commit

Permalink
Changed readme again, formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Artem Skvira committed Oct 18, 2010
1 parent 4b27d8c commit 4340cdc
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Expand Up @@ -40,6 +40,9 @@ appropriate values from host-specific config file.

Loading of configuration is as simple as this:

// Presuming that node-config sits under ./external folder in the project
require.paths.unshift('./external');

var conf = require('node-config'),
sys = require('sys');

Expand All @@ -56,7 +59,7 @@ Loading of configuration is as simple as this:
}
);

## Requirement
## Setup

You need to have a `conf` directory in your project root folder (where your
main .js file sits), and it has to contain`common.js` file with following
Expand All @@ -70,3 +73,7 @@ format:

If you wish to add host-specific config files, execute `hostname` from command
line to find out what your hostname is and name your file accordingly.

Please see `node-config/conf/*` and `node-config/test.js` for examples.

Thanks!

0 comments on commit 4340cdc

Please sign in to comment.