Skip to content

Commit

Permalink
Update README wording again and give thanks to reviewers
Browse files Browse the repository at this point in the history
  • Loading branch information
remarkablemark committed Aug 22, 2016
1 parent dd3f34f commit 4cd0b29
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@

An HTML to React parser.

`Parser(htmlString[, options])`
```
Parser(htmlString[, options])
```

This parser converts an HTML string to [React element(s)](https://facebook.github.io/react/docs/glossary.html#react-elements). There is also a `replace` option if you want to swap a specific element with your own React element.
The parser converts an HTML string to [React element(s)](https://facebook.github.io/react/docs/glossary.html#react-elements). You can also `replace` element(s) with your own custom React element(s) via the parser options.

### Example

Expand All @@ -18,7 +20,9 @@ ReactDOM.render(reactElement, document.getElementById('node'));

## Installation

`npm install html-react-parser`
```sh
$ npm install html-react-parser
```

## Usage

Expand Down Expand Up @@ -93,7 +97,13 @@ ReactDOM.render(reactElement, document.getElementById('root'));

## Testing

`npm test`
```sh
$ npm test
```

## Special Thanks

To [benox3](https://github.com/benox3) and [tdlm](https://github.com/tdlm) for their feedback and review.

## License

Expand Down

0 comments on commit 4cd0b29

Please sign in to comment.