From 1b97d625e603e3d76a2ce46dccffc535f09a9b49 Mon Sep 17 00:00:00 2001
From: Maciej Sypien <maciejsypien@gmail.com>
Date: Sat, 14 Sep 2024 19:54:20 +0200
Subject: [PATCH] feat: update readme

---
 README.md | 36 ++++++++++++++++++++++--------------
 1 file changed, 22 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index b6c3690..ff5426d 100644
--- a/README.md
+++ b/README.md
@@ -56,25 +56,33 @@ Hit `prefix + I` to fetch the plugin and source it. Your Tmux should be updated
 
 ## Development
 
-To run project locally pull the repo to desired place
+To run project locally:
 
-```bash
-cd $HOME/privatespace/
-git clone ...
-```
+1.  clone the repo to desired place
 
-and in `~/.tmux.conf` set
+    ```bash
+    cd $HOME/projects/
+    git clone ...
+    ```
 
-```bash
-# cd to tmux plugin directory
-cd ~/.tmux/plugins/
+1.  create symlink in plugin dir to the cloned repo:
 
-# create simlink to
-ln -sf $HOME/privatespace/tmux-gruvbox/ tmux-gruvbox
+    ```bash
+    # cd to tmux plugin directory
+    cd ~/.tmux/plugins/
 
-# set desired options...
-set -g @tmux-gruvbox 'dark-transparent'
-```
+    # create simlink to cloned repo
+    ln -sf $HOME/projects/tmux-gruvbox/ tmux-gruvbox
+    ```
+
+1.  and in `~/.tmux.conf` set
+
+    ```bash
+    # add plugin
+    set -g @plugin 'egel/tmux-gruvbox'
+    # set desired options...
+    set -g @tmux-gruvbox 'dark'
+    ```
 
 ### Linters & formatters