Skip to content

Update readme #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 10, 2018
Merged

Update readme #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# html-differ
[![Build Status](https://travis-ci.org/markedjs/html-differ.svg)](https://travis-ci.org/markedjs/html-differ)
[![Install Size](https://packagephobia.now.sh/badge?p=@markedjs/html-differ)](https://packagephobia.now.sh/result?p=@markedjs/html-differ)
[![Dependency Status](https://david-dm.org/markedjs/html-differ.svg)](https://david-dm.org/markedjs/html-differ)
[![devDependency Status](https://david-dm.org/markedjs/html-differ/dev-status.svg)](https://david-dm.org/markedjs/html-differ#info=devDependencies)
[![devDependency Status](https://david-dm.org/markedjs/html-differ/dev-status.svg)](https://david-dm.org/markedjs/html-differ?type=dev)

Compares two HTML.

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

```bash
$ npm install html-differ
$ npm install @markedjs/html-differ
```

## API

### HtmlDiffer

```js
var HtmlDiffer = require('html-differ').HtmlDiffer,
var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
htmlDiffer = new HtmlDiffer(options);
```

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

```js
var HtmlDiffer = require('html-differ').HtmlDiffer,
var HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
htmlDiffer = new HtmlDiffer('bem');
```

Redefinition of a preset via the constructor:

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

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

```js
var logger = require('html-differ/lib/logger');
var logger = require('@markedjs/html-differ/lib/logger');
```

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

```js
var fs = require('fs'),
HtmlDiffer = require('html-differ').HtmlDiffer,
logger = require('html-differ/lib/logger');
HtmlDiffer = require('@markedjs/html-differ').HtmlDiffer,
logger = require('@markedjs/html-differ/lib/logger');

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