From 4cd0b298deacb567b71c3fff62636af89b2afa89 Mon Sep 17 00:00:00 2001 From: Mark Date: Mon, 22 Aug 2016 19:40:26 -0400 Subject: [PATCH] Update README wording again and give thanks to reviewers --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a0c0a7af..bae7f4f3 100644 --- a/README.md +++ b/README.md @@ -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 @@ -18,7 +20,9 @@ ReactDOM.render(reactElement, document.getElementById('node')); ## Installation -`npm install html-react-parser` +```sh +$ npm install html-react-parser +``` ## Usage @@ -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