Skip to content

Commit

Permalink
ref #5 Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
ryu1kn committed Feb 17, 2018
1 parent 6450127 commit 383a2a4
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* Whole/Partial text matching
* Matching is done depending on the current mode for whole match. You can toggle the mode from the status bar.
* Highlighting colour is configurable
* Save highlights that will be restored next time you open the editor

Highlight/Unhighlight text. Regular expression can also be used. It highlights your text as you type.

Expand Down Expand Up @@ -51,6 +52,10 @@ You can update a highlight rule after you set it.

Clear all highlights with one shot.

* `Save All Highlights` (**Command ID**: `textmarker.saveAllHighlights`)

Save all highlights that will be restored when opening an editor.

* `Toggle Case Sensitivity` (**Command ID**: `textmarker.toggleCaseSensitivity`)

Toggle the case sensitivity of a highlight.
Expand Down Expand Up @@ -93,6 +98,35 @@ You can update a highlight rule after you set it.

Number of milliseconds to wait before refreshing the highlights on editor contents change. `null` for no refresh.

* `textmarker.savedHighlights`

List of highlights that will get applied when opening editor.
This value is typically set/updated by "**Save All Highlights**" command.

Sample `savedHighlights`:

```
"textmarker.savedHighlights": [
{
"pattern": {
"type": "regex",
"expression": "(TODO|XXX|HACK): .*",
"ignoreCase": false,
"wholeMatch": true
}
},
{
"pattern": {
"type": "string",
"expression": "NOTE",
"ignoreCase": false,
"wholeMatch": false
}
},
...
]
```
## Keyboard Shortcuts
You can quickly invoke the above TextMarker commands by registering them to your keyboard shortcut settings. For example:
Expand Down

0 comments on commit 383a2a4

Please sign in to comment.