Skip to content

Fix typo and add more badges to README #15

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 2 commits into from
Aug 26, 2016
Merged

Fix typo and add more badges to README #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
91f5340
Fix typo and improve wording in README
remarkablemark Aug 26, 2016
6cd5ea6
Add badges from NodeICO, NPM, and David to README
remarkablemark Aug 26, 2016
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
18 changes: 12 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
# html-react-parser [![Build Status](https://travis-ci.org/remarkablemark/html-react-parser.svg?branch=master)](https://travis-ci.org/remarkablemark/html-react-parser) [![Coverage Status](https://coveralls.io/repos/github/remarkablemark/html-react-parser/badge.svg?branch=master)](https://coveralls.io/github/remarkablemark/html-react-parser?branch=master)
# html-react-parser

[![NPM](https://nodei.co/npm/html-react-parser.png)](https://nodei.co/npm/html-react-parser/)

[![NPM version](https://img.shields.io/npm/v/html-react-parser.svg)](https://www.npmjs.com/package/html-react-parser)
[![Build Status](https://travis-ci.org/remarkablemark/html-react-parser.svg?branch=master)](https://travis-ci.org/remarkablemark/html-react-parser)
[![Coverage Status](https://coveralls.io/repos/github/remarkablemark/html-react-parser/badge.svg?branch=master)](https://coveralls.io/github/remarkablemark/html-react-parser?branch=master)
[![Dependency status](https://david-dm.org/remarkablemark/html-react-parser.svg)](https://david-dm.org/remarkablemark/html-react-parser)

An HTML to React parser.

Expand All @@ -15,7 +22,7 @@ var Parser = require('html-react-parser');
var reactElement = (
Parser('<p>Hello, world!</p>') // equivalent to `React.createElement('p', {}, 'Hello, world!')`
);
ReactDOM.render(reactElement, document.getElementById('node'));
require('react-dom').render(reactElement, document.getElementById('root'));
```

## Installation
Expand Down Expand Up @@ -49,7 +56,7 @@ ReactDOM.render(
// nested elements
ReactDOM.render(
Parser('<ul><li>inside</li></ul>'),
document.getElementedById('root')
document.getElementById('root')
);

// attributes are preserved
Expand All @@ -65,7 +72,7 @@ ReactDOM.render(

`replace` allows you to swap an element with your own React element.

The output of `domNode` is the same as the output from [htmlparser2.parseDOM](https://github.com/fb55/domhandler#example).
The `domNode` object has the same schema as the output from [htmlparser2.parseDOM](https://github.com/fb55/domhandler#example).

```js
var Parser = require('html-react-parser');
Expand All @@ -90,8 +97,7 @@ var reactElement = Parser(html, {
}
});

var ReactDOM = require('react-dom');
ReactDOM.render(reactElement, document.getElementById('root'));
require('react-dom').render(reactElement, document.getElementById('root'));
// <div><span style="font-size: 42px;">replaced!</span></div>
```

Expand Down