Commit graph

105 commits

Author SHA1 Message Date
bashbunni a4f52465e7
fix(docs): include winget install 2024-04-22 12:44:33 -07:00
Maas Lalani 1a0111eaff
docs: update readme 2024-04-05 04:20:49 -04:00
Maas Lalani f75dfa668f
docs: add new gifs (#533)
* docs: add new gifs

* Update README.md

* docs: spin.gif

* docs: add spin.gif to readme

* fix: lint

* don't commit filter.tape
2024-04-05 04:16:25 -04:00
Maas Lalani 2a35019323
docs: rework examples section 2024-04-05 02:38:26 -04:00
Maas Lalani 9ab722ca4f
chore: new gifs (JetBrains Mono) 2024-04-05 02:32:16 -04:00
Maas Lalani 42f59ed330
Update README.md (#531) 2024-04-04 02:26:40 -04:00
Maas Lalani 1705593eb9
Clean up README.md 2024-04-04 02:17:07 -04:00
Kevin de9f6b0397
docs(readme): add missing documentation (#513)
add documentation surrounding how to select multiple items in a list and returning them
2024-03-28 13:12:19 -04:00
Kevin Ernst cd115c44e9
Add example and help for gum log --time option to README (#472)
* docs(log): add help for `--time` option

The `gum log --help` output for `--time` option says

```
-t, --time=""             The time format to use (kitchen, layout, ansic, rfc822, etc...)
```

with no indication of what `etc...` means. This is probably inferred for proficient Go programmers, but not for everyone else.

This commit makes it clearer which options are supported by `--time` by linking to the docs for the `time` library,

* Update README.md

* Update README.md

---------

Co-authored-by: Maas Lalani <maas@lalani.dev>
2024-01-12 14:31:18 -05:00
Maas Lalani 3839b8d6e1
docs(log): add gif 2023-11-08 11:11:50 -05:00
Maas Lalani 12ef4d3085
docs(log): add log to the readme 2023-11-08 10:59:16 -05:00
Chris Long ed52291b33
docs: Add WinGet installation details (#401) 2023-07-25 12:23:48 -04:00
Rose Thatcher f048bd8d87
feat(Spin): Option to show live output (#303)
* Added live output buffer and option flag

* Update Spin on README.md

* Returned output formatting to previous version.

* Separated the showOutput and liveOutput flags.
Both flags can now be used at once.

* Removed liveOutout flag
showOutput flag is now realtime

* (spin) Consolodated stderr and stdout

* (spin) Consolodated stdout and stderr

* (spin) If being piped, writes to stdout

* Added error check and did some housekeeping

* No longer outputs to tea.View if piped

* Cleaned up the combining of stderr and stdout

* Fixed spinner alignment.  Updated Readme
2023-06-27 10:31:54 -04:00
Mikael Fangel 38521ff870 fix: correct wrong key combination for gum write in README.md
Fixes #312

### Changes:
 - Moves the `esc` over to the cancel option together with CTRL+c, so it reflects the current behaviour of the program.
2023-03-20 17:47:23 -04:00
Kris Schneider 78bb3b5f06 Added Scoop installation instructions for gum 2023-01-19 11:41:03 -05:00
Christian Muehlhaeuser b87d77554c docs: picture tag is causing display issues 2022-10-24 21:23:52 -04:00
Christian Muehlhaeuser d88f9aec55 docs: new readme footer 2022-10-24 02:46:16 -04:00
Christian Muehlhaeuser 1dec524b9a docs: mention BSD releases 2022-10-22 23:38:10 -04:00
Christian Muehlhaeuser 75c41866b2 docs: add Alpine & termux install instructions 2022-10-22 22:47:40 -04:00
Ayman Bagabas 0b500f6ec9 docs: apt-key deprecation
Use the recommended keyrings path /etc/apt/keyrings

Per: https://manpages.debian.org/unstable/apt/apt-key.8.en.html#DEPRECATION
Fixes: https://github.com/charmbracelet/gum/issues/208
Fixes: https://github.com/charmbracelet/gum/pull/209
2022-10-17 16:45:44 -04:00
David Lewis 1353b97272
added nix flake directions (#195)
* added nix flake directions

Co-authored-by: lew2mz <david.lewis@cchmc.org>
Co-authored-by: Maas Lalani <maas@lalani.dev>
2022-10-13 11:00:04 -04:00
Caeden 1426c2fed9 fix(README): Change .text to .txt 2022-10-08 17:01:32 -04:00
Maas Lalani 995bd04e38 docs: document gum table, file, pager
This commit documents `gum table`, `gum file`, and `gum pager` with
demonstration GIFs and sample scripts.
2022-10-07 15:38:48 -04:00
Ayman Bagabas 0bd02434a3
docs: update apt/yum installation instructions 2022-10-06 17:30:43 -04:00
Maas Lalani 9b0f5f015b
docs(filter): document --no-limit / --limit flag on gum filter 2022-09-30 13:34:21 -04:00
eetann 92cd4b0107 docs: fix write key description 2022-09-07 13:06:25 -04:00
Maas Lalani 7a1a91b4e0
docs: show usage with skate (#136) 2022-08-30 12:24:11 -04:00
Maas Lalani 4cb290e596
docs: Add ENVIRONMENT_VARIABLE configuration to README 2022-08-08 17:06:30 -04:00
Mike Oertli 89f2928571 added clarity on completing a 'write'
added some comments and info in the readme regarding how to complete (or exit) a 'write'
2022-08-05 11:59:01 -04:00
Maas Lalani 60ceeff5dc docs: examples for better sudo and shell history picker 2022-08-05 02:40:21 -04:00
Maas Lalani 6aee67259c fix: resize images 2022-08-05 02:35:52 -04:00
Maas Lalani ff4956a2a6
docs: s/gum-bin/gum 2022-08-04 11:51:05 -04:00
Maas Lalani b042321317
docs: gum is now on official Arch packages 🎉 (use pacman) 2022-08-04 11:50:18 -04:00
Maas Lalani cdd7b7b6ba
docs: document --password flag for gum input 2022-08-02 20:54:16 -04:00
Christian Muehlhaeuser f695901207 chore: nicer PR example in README 2022-08-02 17:35:37 +02:00
Maas Lalani 03e0c80b0c
docs(examples): Move to PR example to README instead of script 2022-08-01 16:09:45 -04:00
Maas Lalani b7f04e04ef
docs: brew install gum 2022-07-31 11:49:38 -04:00
Maas Lalani f0106b51ae
docs: delete branches example 2022-07-30 22:02:07 -04:00
Wissam Youssef fd788a4dd9 Fixes #23 2022-07-30 19:22:26 -04:00
Maas Lalani c886eb142e
docs: spinner types as code 2022-07-30 16:56:22 -04:00
Maas Lalani 27ebad9ee2
docs: list available spinner types 2022-07-30 16:53:24 -04:00
Carlos A Becker 7e3cf1f62f docs: fix example 2022-07-29 12:55:03 -04:00
Carlos A Becker 757e23120e fix: demo in readme requires bash
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
2022-07-29 12:55:03 -04:00
Maas Lalani 0927958421
docs: Use #!/bin/sh instead of #!/bin/bash 2022-07-28 16:24:41 -04:00
Maas Lalani a1f42d99d4
docs: update readme 2022-07-28 08:52:44 -04:00
Maas Lalani e0beb050fd
docs: note on gum confirm exit codes 2022-07-28 08:51:22 -04:00
Maas Lalani d80b425e80
docs: add gum confirm to commit.sh script 2022-07-27 18:40:52 -04:00
Maas Lalani bb3fbab70d
docs: update confirm gif 2022-07-27 17:18:55 -04:00
Christian Rocha 0fefd15009
docs: tiny copy and punctuation improvements 2022-07-27 14:01:25 -07:00
Maas Lalani 03760dea3b
docs: yay -S gum-bin 2022-07-27 15:19:43 -04:00