From b94e924203549b15a05c15490e44c1ebcb2cd71e Mon Sep 17 00:00:00 2001
From: Abhishek Keshri <iam2kabhishek@gmail.com>
Date: Sun, 17 Mar 2024 08:20:49 +0530
Subject: [PATCH] docs: add instructions for adding new plugins

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 27f1c06..dc4296a 100644
--- a/README.md
+++ b/README.md
@@ -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: