From b87d77554ce2f694cc0ea062c56cb9f309a39448 Mon Sep 17 00:00:00 2001 From: Christian Muehlhaeuser Date: Tue, 25 Oct 2022 01:05:37 +0200 Subject: [PATCH] docs: picture tag is causing display issues --- README.md | 108 +++++++++--------------------------------------------- 1 file changed, 18 insertions(+), 90 deletions(-) diff --git a/README.md b/README.md index e4676c1..3057c30 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,7 @@ A tool for glamorous shell scripts. Leverage the power of Gloss](https://github.com/charmbracelet/lipgloss) in your scripts and aliases without writing any Go code! - - - - Shell running the ./demo.sh script - +Shell running the ./demo.sh script The above example is running from a single shell script ([source](./examples/demo.sh)). @@ -89,11 +85,7 @@ DESCRIPTION=$(gum write --placeholder "Details of this change (CTRL+D to finish) gum confirm "Commit changes?" && git commit -m "$SUMMARY" -m "$DESCRIPTION" ``` - - - - Running the ./examples/commit.sh script to commit to git - +Running the ./examples/commit.sh script to commit to git ## Installation @@ -178,11 +170,7 @@ export GUM_INPUT_WIDTH=80 gum input ``` - - - - Gum input displaying most customization options - +Gum input displaying most customization options ## Interaction @@ -200,11 +188,7 @@ Prompt for sensitive input with the `--password` flag. gum input --password > password.txt ``` - - - - Shell running gum input typing Not much, you? - +Shell running gum input typing Not much, you? #### Write @@ -216,11 +200,7 @@ Note: `CTRL+D` and `esc` are used to complete text entry. `CTRL+C` will cancel. gum write > story.txt ``` - - - - Shell running gum write typing a story - +Shell running gum write typing a story #### Filter @@ -233,11 +213,7 @@ echo Cherry >> flavors.txt cat flavors.txt | gum filter > selection.txt ``` - - - - Shell running gum filter on different bubble gum flavors - +Shell running gum filter on different bubble gum flavors You can also select multiple items with the `--limit` flag, which determines the maximum number of items that can be chosen. @@ -277,11 +253,7 @@ echo "What do you need from the grocery store?" cat foods.txt | gum choose --no-limit ``` - - - - Shell running gum choose with numbers and gum flavors - +Shell running gum choose with numbers and gum flavors #### Confirm @@ -292,11 +264,7 @@ Confirm whether to perform an action. Exits with code `0` (affirmative) or `1` gum confirm && rm file.txt || echo "File not removed" ``` - - - - Shell running gum confirm - +Shell running gum confirm #### File @@ -306,11 +274,7 @@ Prompt the user to select a file from the file tree. EDITOR $(gum file $HOME) ``` - - - - Shell running gum file - +Shell running gum file #### Pager @@ -320,11 +284,7 @@ Scroll through a long document with line numbers and a fully customizable viewpo gum pager < README.md ``` - - - - Shell running gum pager - +Shell running gum pager #### Spin @@ -335,11 +295,7 @@ automatically stop after the given command exits. gum spin --spinner dot --title "Buying Bubble Gum..." -- sleep 5 ``` - - - - Shell running gum spin while sleeping for 5 seconds - +Shell running gum spin while sleeping for 5 seconds Available spinner types include: `line`, `dot`, `minidot`, `jump`, `pulse`, `points`, `globe`, `moon`, `monkey`, `meter`, `hamburger`. @@ -351,11 +307,7 @@ Select a row from some tabular data. gum table < flavors.csv | cut -d ',' -f 1 ``` - - - - Shell running gum table - +Shell running gum table ## Styling @@ -370,11 +322,7 @@ gum style \ 'Bubble Gum (1ยข)' 'So sweet and so fresh!' ``` - - - - Bubble Gum, So sweet and so fresh! - +Bubble Gum, So sweet and so fresh! ## Layout @@ -397,11 +345,7 @@ BUBBLE_GUM=$(gum join "$BUBBLE" "$GUM") gum join --align center --vertical "$I_LOVE" "$BUBBLE_GUM" ``` - - - - I LOVE Bubble Gum written out in four boxes with double borders around them. - +I LOVE Bubble Gum written out in four boxes with double borders around them. ## Format @@ -428,11 +372,7 @@ For more information on template helpers, see the [Termenv docs](https://github.com/muesli/termenv#template-helpers). For a full list of named emojis see the [GitHub API](https://api.github.com/emojis). - - - - Running gum format for different types of formats - +Running gum format for different types of formats ## Examples @@ -475,11 +415,7 @@ SESSION=$(tmux list-sessions -F \#S | gum filter --placeholder "Pick session..." tmux switch-client -t $SESSION || tmux attach -t $SESSION ``` - - - -Picking a tmux session with gum filter - +Picking a tmux session with gum filter #### Pick commit hash from your Git history @@ -490,11 +426,7 @@ commit hash of the commit you select. git log --oneline | gum filter | cut -d' ' -f1 # | copy ``` - - - - Picking a commit with gum filter - +Picking a commit with gum filter #### Skate Passwords @@ -506,11 +438,7 @@ Save all your passwords to [Skate](https://github.com/charmbracelet/skate) with skate list -k | gum filter | xargs skate get ``` - - - - Selecting a skate value with gum - +Selecting a skate value with gum #### Choose packages to uninstall