diff --git a/README.md b/README.md index 156678d..16ed84e 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ To customize the keywords and other stuff, command + , (Wi |---|---|---|---| | todohighlight.isEnable | boolean | true | Toggle the highlight, default is true. | | todohighlight.isCaseSensitive | boolean | true | Whether the keywords are case sensitive or not. | -| todohighlight.keywords | array | N/A | An array of keywords that will be hilighted. You can also specify the style for each keywords here. See example below for more infomation. | +| todohighlight.keywords | array | N/A | An array of keywords that will be highlighted. You can also specify the style for each keywords here. See example below for more infomation. | | todohighlight.keywordsPattern | string | N/A | Specify keywords via RegExp instead of `todohighlight.keywords` one by one. NOTE that if this presents, `todohighlight.keywords` will be ignored. And REMEMBER to escapse the back slash if there's any in your regexp (using \\ instead of signle back slash). | | todohighlight.defaultStyle | object | N/A | Specify the default style for custom keywords, if not specified, build in default style will be applied. [See all available properties on VSCode doc DecorationRenderOptions section](https://code.visualstudio.com/docs/extensionAPI/vscode-api) | | todohighlight.include | array | [
`"**/*.js"`,
`"**/*.jsx"`,
`"**/*.ts"`,
`"**/*.tsx",`
`"**/*.html"`,
`"**/*.php"`,
`"**/*.css",`
`"**/*.scss"`
] | Glob patterns that defines the files to search for. Only include files you need, DO NOT USE `{**/*.*}` for both permormance and avoiding binary files reason.
For backwards compatability, a string combine all the patterns is also valid `"{**/*.js,**/*.jsx,**/*.ts,**/*.tsx,**/*.html,**/*.php,**/*.css,**/*.scss}"` |