diff --git a/README.md b/README.md index 8d0b4e5..8923144 100644 --- a/README.md +++ b/README.md @@ -200,28 +200,38 @@ markdown, code, template strings, and emoji strings. For example, we can output a markdown list with the following command: ```bash -gum format "# Gum Formats" "- Markdown" "-Code" "-Template" "- Emoji" +gum format -- "# Gum Formats" "- Markdown" "- Code" "- Template" "- Emoji" echo "# Gum Formats\n- Markdown\n- Code\n- Template\n- Emoji" | gum format ``` -Apply syntax highlighting to code with `gum format code`: +Format markdown displaying a markdown list with content of different possible formats + +Apply syntax highlighting to code with `gum format -t code`: ```bash cat main.go | gum format -t code ``` -Render a template string: +Format code command displaying a simple Hello, world! Go program with syntax highlighting. + +Render a template string with `gum format -t template`: ```bash -echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' | gum format -t template +echo '{{ Bold "Tasty" }} {{ Italic "Bubble" }} {{ Color "99" "0" " Gum " }}' \ + | gum format -t template ``` -Render some emojis with `:emoji:` syntax. +Format template command displaying Tasty Bubble Gum in different styles + +Render some emojis with `:emoji:` syntax with `gum format -t emoji`. ```bash echo 'I :heart: Bubble Gum :candy:' | gum format -t emoji ``` +Format emoji command displaying I :heart: Bubble Gum :candy:. + + ## Examples See the [examples](./examples/) directory for more real world use cases.