Skip to content

Commit 658abaf

Browse files
committed
docs: add a demo video
1 parent 8c50b5b commit 658abaf

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,29 @@
22

33
A handy plugin that helps create toggleable popups.
44

5+
[demo.webm](https://github.com/loichyan/tmux-toggle-popup/assets/73006950/99a94285-3839-4fe0-949f-5649ad34d5a5)
6+
7+
<details>
8+
<summary>Environment</summary>
9+
<br>
10+
11+
- DE: [Gnome 46](https://release.gnome.org/46) & [PaperWM](https://github.com/paperwm/PaperWM)
12+
- Tmux: [Catppuccin theme](https://github.com/catppuccin/tmux)
13+
- Font: [Rec Mono Duotone](https://www.recursive.design)
14+
- Keystrokes: [Show Me the Key](https://showmethekey.alynx.one)
15+
- Rickroll: [rickrollrc](https://github.com/keroserene/rickrollrc)
16+
17+
_Check
18+
[the dotfiles](https://github.com/loichyan/dotfiles/tree/5899f0e7572de4102261051277b22990e53f8bed)
19+
for more details_
20+
21+
</details>
22+
523
## 📦 Installation
624

725
### Requirements
826

9-
- TMUX >= **3.4** (not tested on earlier versions)
27+
- Tmux >= **3.4** (not tested on earlier versions)
1028

1129
### With [Tmux Plugin Manager](https://github.com/tmux-plugins/tpm) (recommended)
1230

@@ -30,7 +48,7 @@ Add this line to the bottom of `.tmux.conf`:
3048
run ~/clone/path/toggle-popup.tmux
3149
```
3250

33-
Reload TMUX environment with: `tmux source-file ~/.tmux.conf`. You should now be able to use the
51+
Reload Tmux environment with: `tmux source-file ~/.tmux.conf`. You should now be able to use the
3452
plugin.
3553

3654
## ✍️ Usage

assets/demo.mp4

1.02 MB
Binary file not shown.

0 commit comments

Comments
 (0)