Skip to content

Commit

Permalink
module(uptime): update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
vdbe committed Mar 16, 2024
1 parent 4c2136e commit f749175
Showing 1 changed file with 1 addition and 22 deletions.
23 changes: 1 addition & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,6 +290,7 @@ Available modules:
- user - display the username
- host - display the hostname
- date_time - display the date and time
- uptime - display the uptime
- [battery](#battery-module) - display the battery

### Customizing modules
Expand Down Expand Up @@ -405,28 +406,6 @@ Add the load module to the status modules list.
set -g @catppuccin_status_modules_right "... load ..."
```

### Uptime module

#### Requirements
This module depends on [tmux-uptime](https://github.com/robhurring/tmux-uptime).

#### Install
The prefered way to install tmux-uptime is using [TPM](https://github.com/tmux-plugins/tpm).

#### Configure
Load tmux-uptime after you load catppuccin.

```sh
set -g @plugin 'catppuccin/tmux'
...
set -g @plugin 'robhurring/tmux-uptime'
```

Add the uptime module to the status modules list.
```sh
set -g @catppuccin_status_modules_right "... uptime ..."
```

## Create a custom module

It is possible to add a new custom module or overwrite any of the existing modules.
Expand Down

0 comments on commit f749175

Please sign in to comment.