From 12249084459fc9b9b8ede757663ac90796af58fb Mon Sep 17 00:00:00 2001 From: Chris Lane Date: Fri, 11 Jan 2019 16:36:17 -0500 Subject: [PATCH] README edits Updated the README to mention the new `CHEAT_HIGHLIGHT` environment variable. --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 600eaf5..8132ebc 100644 --- a/README.md +++ b/README.md @@ -137,6 +137,23 @@ WHERE id = 100 If no syntax highlighter is specified, the `bash` highlighter will be used by 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: ---------