README edits

Updated the README to mention the new `CHEAT_HIGHLIGHT` environment
variable.
This commit is contained in:
Chris Lane 2019-01-11 16:36:17 -05:00
parent 28a2902e20
commit 1224908445
1 changed files with 17 additions and 0 deletions

View File

@ -137,6 +137,23 @@ WHERE id = 100
If no syntax highlighter is specified, the `bash` highlighter will be used by If no syntax highlighter is specified, the `bash` highlighter will be used by
default. default.
### Enabling Search Match Highlighting ###
`cheat` can optionally be configured to highlight search term matches in search
results. To do so, export a `CHEAT_HIGHLIGHT` environment variable with a value
of one of the following:
- blue
- cyan
- green
- grey
- magenta
- red
- white
- yellow
Note that the `termcolor` module must be installed on your system for this to
work.
See Also: See Also:
--------- ---------