Skip to content

Commit 4d4382c

Browse files
authored
Merge pull request #8 from styfle/patch-1
Update readme
2 parents bb17cda + a6419d5 commit 4d4382c

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# html-differ
22
[![Build Status](https://travis-ci.org/markedjs/html-differ.svg)](https://travis-ci.org/markedjs/html-differ)
3+
[![Install Size](https://packagephobia.now.sh/badge?p=@markedjs/html-differ)](https://packagephobia.now.sh/result?p=@markedjs/html-differ)
34
[![Dependency Status](https://david-dm.org/markedjs/html-differ.svg)](https://david-dm.org/markedjs/html-differ)
4-
[![devDependency Status](https://david-dm.org/markedjs/html-differ/dev-status.svg)](https://david-dm.org/markedjs/html-differ#info=devDependencies)
5+
[![devDependency Status](https://david-dm.org/markedjs/html-differ/dev-status.svg)](https://david-dm.org/markedjs/html-differ?type=dev)
56

67
Compares two HTML.
78

@@ -94,15 +95,15 @@ For example, the following two code samples will be considered to be equivalent:
9495
## Install
9596

9697
```bash
97-
$ npm install html-differ
98+
$ npm install @markedjs/html-differ
9899
```
99100

100101
## API
101102

102103
### HtmlDiffer
103104

104105
```js
105-
var HtmlDiffer = require('html-differ').HtmlDiffer,
106+
var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
106107
htmlDiffer = new HtmlDiffer(options);
107108
```
108109

@@ -299,14 +300,14 @@ For example, the following two code samples will be considered to be equivalent:
299300
Passing of a preset via the constructor:
300301

301302
```js
302-
var HtmlDiffer = require('html-differ').HtmlDiffer,
303+
var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
303304
htmlDiffer = new HtmlDiffer('bem');
304305
```
305306

306307
Redefinition of a preset via the constructor:
307308

308309
```js
309-
var HtmlDiffer = require('html-differ').HtmlDiffer,
310+
var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
310311
htmlDiffer = new HtmlDiffer({ preset: 'bem', ignoreAttributes: [] });
311312
```
312313

@@ -328,7 +329,7 @@ var HtmlDiffer = require('html-differ').HtmlDiffer,
328329
### Logger
329330

330331
```js
331-
var logger = require('html-differ/lib/logger');
332+
var logger = require('@markedjs/html-differ/lib/logger');
332333
```
333334

334335
#### Methods
@@ -357,8 +358,8 @@ var logger = require('html-differ/lib/logger');
357358

358359
```js
359360
var fs = require('fs'),
360-
HtmlDiffer = require('html-differ').HtmlDiffer,
361-
logger = require('html-differ/lib/logger');
361+
HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
362+
logger = require('@markedjs/html-differ/lib/logger');
362363

363364
var html1 = fs.readFileSync('1.html', 'utf-8'),
364365
html2 = fs.readFileSync('2.html', 'utf-8');

0 commit comments

Comments
 (0)