Skip to content

Commit 4cd0b29

Browse files
Update README wording again and give thanks to reviewers
1 parent dd3f34f commit 4cd0b29

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,11 @@
22

33
An HTML to React parser.
44

5-
`Parser(htmlString[, options])`
5+
```
6+
Parser(htmlString[, options])
7+
```
68

7-
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.
9+
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.
810

911
### Example
1012

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

1921
## Installation
2022

21-
`npm install html-react-parser`
23+
```sh
24+
$ npm install html-react-parser
25+
```
2226

2327
## Usage
2428

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

9498
## Testing
9599

96-
`npm test`
100+
```sh
101+
$ npm test
102+
```
103+
104+
## Special Thanks
105+
106+
To [benox3](https://github.com/benox3) and [tdlm](https://github.com/tdlm) for their feedback and review.
97107

98108
## License
99109

0 commit comments

Comments
 (0)