Add documentation about EnvColorProfile

muesli · Feb 6, 2022 · 662a4e4 · 662a4e4
1 parent ce3deab
commit 662a4e4
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -48,6 +48,10 @@ This returns one of the supported color profiles:
 - `termenv.ANSI256` - Extended 256 color ANSI support
 - `termenv.TrueColor` - RGB/TrueColor support
 
+Alternatively, you can use `termenv.EnvColorProfile` which evaluates the
+terminal like `ColorProfile`, but also respects the `NO_COLOR` and
+`CLICOLOR_FORCE` environment variables.
+
 You can also query the terminal for its color scheme, so you know whether your
 app is running in a light- or dark-themed environment:
 

diff --git a/termenv_windows.go b/termenv_windows.go
@@ -51,7 +51,7 @@ func backgroundColor() Color {
 
 // EnableWindowsANSIConsole enables virtual terminal processing on Windows
 // platforms. This allows the use of ANSI escape sequences in Windows console
-//  applications. Ensure this gets called before anything gets rendered with
+// applications. Ensure this gets called before anything gets rendered with
 // termenv.
 //
 // Returns the original console mode and an error if one occurred.