From 4cb290e59683225f9a9919cfaff3ec9139cc6da2 Mon Sep 17 00:00:00 2001
From: Maas Lalani <maas@lalani.dev>
Date: Mon, 8 Aug 2022 17:06:30 -0400
Subject: [PATCH] docs: Add `ENVIRONMENT_VARIABLE` configuration to README

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 295ba72..c9ec0f3 100644
--- a/README.md
+++ b/README.md
@@ -152,6 +152,21 @@ gum input --cursor.foreground "#FF0" --prompt.foreground "#0FF" --prompt "* " \
     --placeholder "What's up?" --width 80 --value "Not much, hby?"
 ```
 
+You can also use `ENVIRONMENT_VARIABLES` to customize `gum` by default, this is
+useful to keep a consistent theme for all your `gum` commands.
+
+```bash
+export GUM_INPUT_CURSOR_FOREGROUND="#FF0"
+export GUM_INPUT_PROMPT_FOREGROUND="#0FF"
+export GUM_INPUT_PLACEHOLDER="What's up?"
+export GUM_INPUT_PROMPT="* "
+export GUM_INPUT_WIDTH=80
+
+# Uses values configured through environment variables above but can still be
+# overridden with flags.
+gum input
+```
+
 <picture>
   <source media="(max-width: 600px)" srcset="https://stuff.charm.sh/gum/customization.gif">
   <source media="(min-width: 600px)" width="600" srcset="https://stuff.charm.sh/gum/customization.gif">