refactor: improve readme and outsource images to external platform

This commit is contained in:
Maciej Sypien 2024-09-16 22:05:30 +02:00
parent 6caaf72088
commit 8aca1de5a8
No known key found for this signature in database
GPG key ID: 10BC01EDA6827DC8
4 changed files with 24 additions and 8 deletions

View file

@ -64,11 +64,13 @@ Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated
- default value: `dark256` - default value: `dark256`
- available themes: - available themes:
- [`dark256`](./docs/assets/img/gruvbox-dark-theme.png) - `dark` ([preview]())
- [`light256`](./docs/assets/img/gruvbox-light-theme.png) - `light` ()
- `dark256` ([preview]())
- `light256` ([preview](https://i.imgur.com/fvpdRjg.png))
```bash ```bash
set -g @tmux-gruvbox 'dark256' set -g @tmux-gruvbox 'dark'
``` ```
### Transparent status-bar ### Transparent status-bar
@ -95,7 +97,13 @@ set -g @tmux-gruvbox-left-status-a
This section is customizable for user, and by default contains current date. This section is customizable for user, and by default contains current date.
```bash ```bash
set -g @tmux-gruvbox-right-status-x # set date in US notation
set -g @tmux-gruvbox-right-status-x '%m/%d/%Y' # e.g.: 01/31/2024
```
```bash
# or set date in EU notation
set -g @tmux-gruvbox-right-status-x '%d.%m.%Y' # e.g.: 30.01.2024
``` ```
### Right Status (Section Y) ### Right Status (Section Y)
@ -105,8 +113,8 @@ set -g @tmux-gruvbox-right-status-x
This section is customizable for user, and by default contains current time. This section is customizable for user, and by default contains current time.
```bash ```bash
# set different time format # set US time format
set -g @tmux-gruvbox-right-status-y '%H:%M' set -g @tmux-gruvbox-right-status-y '%I:%M %p' # 09:54 PM
``` ```
### Right Status (Section Z) ### Right Status (Section Z)
@ -116,10 +124,13 @@ set -g @tmux-gruvbox-right-status-y '%H:%M'
This section is customizable for user, and by default contains hostname. This section is customizable for user, and by default contains hostname.
```bash ```bash
# enhance this section with other plugin # display hostname and enhance section with other plugin
set -g @tmux-gruvbox-right-status-z '#h #{tmux_mode_indicator}' set -g @tmux-gruvbox-right-status-z '#h #{tmux_mode_indicator}'
``` ```
> ![TIP]: make sure the themes' settings are defined before all other plugins,
> otherwise plugin's content may not be displayed correctly in by the theme.
## Development ## Development
To run project locally: To run project locally:
@ -171,3 +182,8 @@ GPLv3 - Maciej Sypień
[tmux-color-solarized]: https://github.com/seebi/tmux-colors-solarized [tmux-color-solarized]: https://github.com/seebi/tmux-colors-solarized
[pexcel-1]: https://www.pexels.com/photo/urban-photo-of-an-alley-2411688/ [pexcel-1]: https://www.pexels.com/photo/urban-photo-of-an-alley-2411688/
[pexcel-2]: https://www.pexels.com/photo/lights-hanging-above-the-alley-in-a-city-at-night-27044195/ [pexcel-2]: https://www.pexels.com/photo/lights-hanging-above-the-alley-in-a-city-at-night-27044195/
[imgur-img-gruvbox-dark-light-comparision-1x]: https://i.imgur.com/uGyGwlC.png
[imgur-img-gruvbox-dark-light-comparision-0.5x]: https://i.imgur.com/p6lUnzb.png
[imgur-img-gruvbox-dark-16bit-1x]: https://i.imgur.com/ae88LQI.png
[imgur-img-gruvbox-dark256-1x]: https://i.imgur.com/kzQTTCa.png
[imgur-img-gruvbox-light-1x]: https://i.imgur.com/fvpdRjg.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 334 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.3 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.9 MiB