Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
eGavr committed Jul 23, 2014
1 parent 8f3c3b6 commit ec27713
Showing 1 changed file with 2 additions and 10 deletions.
12 changes: 2 additions & 10 deletions README.md
Expand Up @@ -84,7 +84,6 @@ var html1 = fs.readFileSync('1.html', 'utf-8'),
var options = {
ignoreHtmlAttrs: [],
compareHtmlAttrsAsJSON: [],
verbose: true,
ignoreWhitespace: true,
bem: false
}
Expand All @@ -106,9 +105,7 @@ where ```options``` is the ```Object```:

* ```compareHtmlAttrsAsJSON: [ Array ]``` - sets what respective attributes' content will be compared as ```JSONs```, not as ```Strings```

* ```verbose: Boolean``` - see [here](https://github.com/tautologistics/node-htmlparser#option-verbose)

* ```ignoreWhitespace: Boolean``` - see [here](https://github.com/tautologistics/node-htmlparser#option-ignorewhitespace)
* ```ignoreWhitespace: Boolean``` - if is set ```true```, ```html-differ``` will consider all groups of ```spaces```, ```new lines```, ```tabs``` as one ```space```

* ```bem: Boolean``` - predefined options for BEM

Expand All @@ -119,10 +116,6 @@ Options for BEM are predefined:

* ```compareHtmlAttrsAsJSON: ['data-bem', 'onclick', 'ondblclick']```

* ```verbose: true```

* ```ignoreWhitespace: true```

* ```charsAroundDiff: 40```


Expand All @@ -139,7 +132,7 @@ Options:
-h, --help : Help
-v, --version : Shows the version number
--config=CONFIG : Path to configuration JSON-file
--chars-around-diff=CHARSAROUNDDIFF : The number of characters around the diff
--chars-around-diff=CHARSAROUNDDIFF : The number of characters around the diff (default: 40)

Arguments:
PATH1 : Path to the 1-st html-file (required)
Expand All @@ -162,7 +155,6 @@ Study the following ```config.json```:
{
"ignoreHtmlAttrs": [],
"compareHtmlAttrsAsJSON": [],
"verbose": true,
"ignoreWhitespace": true,
"bem": false
}
Expand Down

0 comments on commit ec27713

Please sign in to comment.