Skip to content

Commit ac69a8f

Browse files
docs(readme): tidy code blocks in README.md
1 parent f06707b commit ac69a8f

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

README.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -29,26 +29,26 @@ Parser('<p>Hello, world!</p>');
2929
## Installation
3030

3131
[NPM](https://www.npmjs.com/package/html-react-parser):
32-
3332
```sh
34-
npm install html-react-parser --save
33+
$ npm install html-react-parser --save
3534
```
3635

3736
[Yarn](https://yarn.fyi/html-react-parser):
38-
3937
```sh
40-
yarn add html-react-parser
38+
$ yarn add html-react-parser
4139
```
4240

4341
[CDN](https://unpkg.com/html-react-parser/):
44-
4542
```html
4643
<!-- HTMLReactParser depends on React -->
4744
<script src="https://unpkg.com/react@16/umd/react.production.min.js"></script>
4845
<script src="https://unpkg.com/html-react-parser@latest/dist/html-react-parser.min.js"></script>
46+
<script>
47+
window.HTMLReactParser(/* string */);
48+
</script>
4949
```
5050

51-
More [examples](https://github.com/remarkablemark/html-react-parser/tree/master/examples).
51+
See more [examples](https://github.com/remarkablemark/html-react-parser/tree/master/examples).
5252

5353
## Usage
5454

@@ -180,18 +180,17 @@ Parser('<p><br id="remove"></p>', {
180180
## Testing
181181

182182
```sh
183-
npm test
184-
npm run lint # npm run lint:fix
183+
$ npm test
184+
$ npm run lint # npm run lint:fix
185185
```
186186

187187
## Benchmarks
188188

189189
```sh
190-
npm run test:benchmark
190+
$ npm run test:benchmark
191191
```
192192

193193
Here's an example output of the benchmarks run on a MacBook Pro 2017:
194-
195194
```
196195
html-to-react - Single x 415,186 ops/sec ±0.92% (85 runs sampled)
197196
html-to-react - Multiple x 139,780 ops/sec ±2.32% (87 runs sampled)
@@ -201,9 +200,9 @@ html-to-react - Complex x 8,118 ops/sec ±2.99% (82 runs sampled)
201200
## Release
202201

203202
```sh
204-
npm run release
205-
npm publish
206-
git push --follow-tags
203+
$ npm run release
204+
$ npm publish
205+
$ git push --follow-tags
207206
```
208207

209208
## Special Thanks

0 commit comments

Comments
 (0)