technofab/tmux2k
1
0
Fork 0
mirror of https://github.com/TECHNOFAB11/tmux2k.git synced 2025-12-11 23:50:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add instructions for adding new plugins

Browse source
This commit is contained in:
Abhishek Keshri 2024-03-17 08:20:49 +05:30
parent d6ac3d6055
commit b94e924203
No known key found for this signature in database
1 changed files with 8 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -55,6 +55,12 @@ Available Plugins:
- `time`: Show current time and date
- `weather`: Show weather information
### Add New Plugins
To add a new plugin, add a script to the [scripts](./scripts) folder that prints something to the console.
> The plugin name and script file name must match e.g: plugin named `foo` should have a file called `scripts/foo.sh`
## Prerequisites
Before you begin, ensure you have met the following requirements:
@ -117,6 +123,8 @@ set -g @tmux2k-[plugin-name]-colors "[background] [foreground]"
set -g @tmux2k-cpu-colors "blue dark_gray"
```
> You may have to restart `tmux` for some changes to reflect
### Colors
### Available Colors: