bvaughn / react-highlight-words

React component to highlight words within a larger body of text
https://bvaughn.github.io/react-highlight-words/
MIT License
2.16k stars 170 forks source link

Emphasise RegExp behaviour of "searchWords" in readme #37

Closed RichardBradley closed 6 years ago

RichardBradley commented 6 years ago

I found it rather surprising that the searchWords are treated as RegExp by default. This PR tweaks the Readme slightly so that new users are less likely to be cut on this sharp edge.

Issue #12 discusses changing this default and concludes "changing the default would require a major release"

bvaughn commented 6 years ago

Cool, thanks