Skip to content
This repository has been archived by the owner on Apr 25, 2019. It is now read-only.

Commit

Permalink
Update to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
roeldev committed May 1, 2015
1 parent 3e62e1c commit d9bfb4b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 11 deletions.
5 changes: 2 additions & 3 deletions .jscsrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
{
"disallowDanglingUnderscores": true,
"disallowEmptyBlocks": true,
"disallowImplicitTypeConversion": ["numeric", "binary", "string"],
"disallowKeywords": ["with"],
Expand Down Expand Up @@ -32,10 +31,10 @@
"requireLineFeedAtFileEnd": true,
"requireNewlineBeforeBlockStatements": true,
"requireOperatorBeforeLineBreak": true,
"requirePaddingNewLineAfterVariableDeclaration": true,
//"requirePaddingNewLineAfterVariableDeclaration": true,
//"requirePaddingNewLinesAfterBlocks": true,
"requirePaddingNewlinesBeforeKeywords":
["do", "for", "if", "switch", "case", "try", "void", "while", "function"],
["do", "case", "try", "void", "while", "function"],
//"requirePaddingNewLinesInObjects": true,
"requireParenthesesAroundIIFE": true,
"requireQuotedKeysInObjects": true,
Expand Down
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,10 @@ npm install --save confirge

## How to use
```js
var confirge = require('confirge'),
config;
var confirge = require('confirge');

// basic usage, load from a file
config = confirge('config.yml');
var config = confirge('config.yml');

// load from a file, returned by a function
config = confirge(function()
Expand Down Expand Up @@ -65,7 +64,7 @@ When a function is passed, it is assumed this function returns the path to a fil

### confirge.replace(source, vars)
Loops through all source values and replaces any used variables wich are defined in the vars object.
Loops through all (nested) source values and replaces any found variables.

#### `source`
> Type: `object` or `array`
Expand All @@ -92,7 +91,7 @@ Extend a base object with the given sources. These sources are handled by the ma
[david-img]: https://david-dm.org/roeldev/confirge.svg
[david-url]: https://david-dm.org/roeldev/confirge

[api-confirge]: #confirge2
[api-confirge-read]: #1
[api-confirge-replace]: #2
[api-confirge-extend]: #3
[api-confirge]: #confirgesource
[api-confirge-read]: #confirgereadfile
[api-confirge-replace]: #confirgereplacesource-vars
[api-confirge-extend]: #confirgeextendsource

0 comments on commit d9bfb4b

Please sign in to comment.