From 74ef27748646a9dcaff624c6eec885bb92e99a62 Mon Sep 17 00:00:00 2001 From: Maas Lalani Date: Fri, 15 Jul 2022 16:11:32 -0400 Subject: [PATCH] docs: customization flags --- README.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 63d2365..39c06bb 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,12 @@ Build Status

+ Gum is a collection of command-line utilities that make your shell scripts a little more glamorous. It gives you the power of -[Bubbles](https://github.com/charmbracelet/bubbles) and -[Lip Gloss](https://github.com/charmbracelet/lipgloss) without needing to write -any Go code. +[Bubbles](https://github.com/charmbracelet/bubbles) and [Lip +Gloss](https://github.com/charmbracelet/lipgloss) without needing to write any +Go code. ```bash # Prompt users for input @@ -73,6 +74,21 @@ go install github.com/charmbracelet/gum@latest [releases]: https://github.com/charmbracelet/gum/releases +## Customization + +`gum` is designed to be embedded in scripts and different use cases. All +components are configurable and customizable to fit your theme and use case. + +You can customize with `--flags`. See `gum --help` for a full view of +all the command's customization and configuration options. + +For example, let's customize the cursor color, prompt color, prompt indicator, +placeholder text, width, and pre-populate the value of the input: +```bash +gum input --cursor.foreground "#FF0" --prompt.foreground "#0FF" --prompt "* " \ + --placeholder "What's up?" --width 80 --value "Not much, hby?" +``` + ## Interaction #### Input