Skip to content

Commit d01e1c8

Browse files
docs(readme): update FAQ and tidy Release section
1 parent 570bf1a commit d01e1c8

File tree

1 file changed

+14
-5
lines changed

1 file changed

+14
-5
lines changed

README.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ parse('<div>text</div>'); // equivalent to `React.createElement('div', {}, 'text
2424

2525
[CodeSandbox](https://codesandbox.io/s/940pov1l4w) | [JSFiddle](https://jsfiddle.net/remarkablemark/7v86d800/) | [repl.it](https://repl.it/@remarkablemark/html-react-parser)
2626

27-
See [usage](#usage) and more [examples](https://github.com/remarkablemark/html-react-parser/tree/master/examples).
27+
See [usage](#usage) and [examples](https://github.com/remarkablemark/html-react-parser/tree/master/examples).
2828

2929
## Installation
3030

@@ -176,9 +176,17 @@ parse('<p><br id="remove"></p>', {
176176

177177
## FAQ
178178

179-
#### Is this library XSS safe?
179+
#### Is the library XSS safe?
180180

181-
No, this library does _not_ sanitize against [XSS (Cross-Site Scripting)](https://wikipedia.org/wiki/Cross-site_scripting). See [#94](https://github.com/remarkablemark/html-react-parser/issues/94) for more details.
181+
No, this library does **_not_** sanitize against [XSS (Cross-Site Scripting)](https://wikipedia.org/wiki/Cross-site_scripting). See [#94](https://github.com/remarkablemark/html-react-parser/issues/94).
182+
183+
#### Are `<script>` tags parsed?
184+
185+
Although `<script>` tags are parsed, [react-dom](https://reactjs.org/docs/react-dom.html) does not render the contents. See [#98](https://github.com/remarkablemark/html-react-parser/issues/98).
186+
187+
#### My HTML attributes aren't getting called.
188+
189+
That's because [inline event handlers](https://developer.mozilla.org/docs/Web/Guide/Events/Event_handlers) like `onclick` are parsed as a _string_ rather than a _function_. See [#73](https://github.com/remarkablemark/html-react-parser/issues/73).
182190

183191
## Testing
184192

@@ -203,10 +211,11 @@ html-to-react - Complex x 8,118 ops/sec ±2.99% (82 runs sampled)
203211

204212
## Release
205213

214+
Only collaborators with credentials can release and publish:
215+
206216
```sh
207217
$ npm run release
208-
$ npm publish
209-
$ git push --follow-tags
218+
$ git push --follow-tags && npm publish
210219
```
211220

212221
## Special Thanks

0 commit comments

Comments
 (0)