Release 0.4.0 version! Check the Changelog!

This commit introduces the following changes:

 - Splits Support: Users can now define multi-pane windows in their YAML configuration using the panes field. Supported layouts include tiled, even-horizontal, and even-vertical.

 - Enhanced Preview: The fzf preview window now displays detailed information about splits, including pane commands and layouts.

 - Improved Error Handling: Added clearer error messages for invalid configurations, such as duplicate session names or unsupported layouts.

 - Refactored Code: Cleaned up the session creation logic to handle splits more efficiently.

Author: MrSloth-dev

README.md

@@ -1,50 +1,131 @@
-# Zmux-Sessionizer
-Zmux is a shell script written in bash to create, manage and open session in `Tmux`.
-You can check [here](https://github.com/MrSloth-dev/.dotfiles/blob/main/scripts/zmux.sh) the shell script that was the origin of the idea for this plugin.
+# ⚡⚙️ Zmux-Sessionizer ⚡⚙️
+
+Zmux is a bash script designed to make, managing and creating Tmux sessions a breeze.
+
+Whether you're juggling multiple projects or just need a quick way to organize your workflow, Zmux has got you covered!
+
+
 
 ![img](assets/preview.png)
 
-# Instalation
+
+## Instalation 📥
+
+### Step 1: Download Zmux
+Choose a directory where you want to install Zmux (e.g., `~/.local/bin`, `~/bin`, or any directory in your `$PATH`).
+``` bash
+# Example: Install to ~/.local/bin
+mkdir -p ~/.local/bin
+curl -o ~/.local/bin/zmux https://raw.githubusercontent.com/MrSloth-dev/eZmux/main/zmux
+chmod +x ~/.local/bin/zmux
+```
+
+### Step 2: Add to $PATH
+Ensure the installation directory is in your `$PATH`. Add the following line to your shell configuration file (`~/.bashrc`, `~/.zshrc`, etc.):
 
 ``` bash
-mkdir -p ~/.local/bin/
-wget https://raw.githubusercontent.com/MrSloth-dev/eZmux/refs/heads/main/zmux -O ~/.local/bin/zmux
-chmod u+x ~/.local/bin/zmux
-# Add to .bashrc or .zshrc or add /.local/bin to $PATH
-# echo 'alias zmux="~/.local/bin/zmux"' >> ~/.zshrc
-export PATH=$PATH:~/.local/bin/
-source ~/.zshrc
+export PATH=$PATH:~/.local/bin  # Replace with your chosen directory
+```
+Then reload your shell:
+```bash
+source ~/.zshrc  # or ~/.bashrc
+```
+### Step 3: Verify Instalation
+Check if Zmux is installed correctly
+```bash
+zmux -v
 ```
 
-## Dependencies
+## Dependencies ⚙️
 
 - `tmux` version greater or equal to `v3.3`.
 - `yq` version greater or equal to `v4.44.6`. This tool allows the configuration parsing.
 - `fzf` This tool allows quick and interactive listing of all pre-configured and opened sessions.
 - `yamllint` This tool check if configuration files are well formatted.
 
-# Usage
+## Usage 🛠️
 
-The main goal of this script is to be simple, there are two ways of invoking the script:
- - `zmux` will spawn a `fzf` window that list all active and pre-configured sessions.
+Zmux is designed to be simple and intuitive. You can use it in several ways:
+
+### List and Select Sessions
+
+Run zmux without any arguments to open an interactive fzf window. This lists all active and pre-configured sessions.
 
 ![img](assets/preview.png)
 
- **Note**: Press Ctrl-t to toggle the `fzf` preview-window.
+Press Ctrl-t to toggle the preview window, which shows detailed information about the selected session, including:
+
+ - Session status (active/inactive).
+
+ - Configured windows and panes.
+
+ - Layouts and commands for each pane.
+
+### Open or Create a Specific Session
+
+Run `zmux <session-name>` to open or create a specific session. If the session does not exist, Zmux will prompt you to create it.
+ - If the session is pre-configured in your YAML files, Zmux will create the session with the specified windows, panes, and commands.
+
+ - If the session does not exist, Zmux will create a new session with the given name.
+
+### Export Current Session Configuration
+
+Use the -e or --export flag to export the current session configuration to a YAML file. This is useful for saving session setups for future use.
+
+ - Zmux will prompt you to select a configuration file or create a new one.
+
+ - The exported configuration will include:
+
+  - Root directory.
+
+  - Windows and their respective panes.
+
+  - Commands for each pane.
+
+### Kill Session or Server
 
- - `zmux <sesison-name>` will search if session is active or exist in configuration files. If not, it prompts the user to create a new session.
+Use the `-k <session-name>` or --kill flag to kill the selected session. To kill the Tmux server and close all sessions use `-k all`
 
- - `zmux -k` or `--kill` to kill the `tmux` server
+### Check Configuration Files
 
- - `zmux -e` or `--export` to export the current session into a `YAML` file
+Use the `-c` or `--check` flag to validate your YAML configuration files with `yamllint`.
+ - This ensures your configuration files are well-formatted and free of errors.
 
- - `zmux -c` or `--check` to the `YAML` configuration file and ouputs if found any errors.
+### Print Help
 
- - `zmux -h` or `--help` to print the help message
+Use the `-h` or `--help` flag to display the help message.
 
- - `zmux -v` or `--version` to print the version
+### Using Split (v0.4.0+)
 
-# Configuration
+You can now configure splits (panes) within windows in your session configuration. Each window can have multiple panes with customizable layouts and commands.
+
+### Example Configuration
+
+``` yaml
+sessions:
+  project_a:
+    root: ~/Projects/ProjectA/
+    windows:
+      - name: Editor
+        layout: tiled  # Supported layouts: tiled, even-horizontal, even-vertical
+        panes:
+          - command: nvim .
+          - command: htop
+      - name: Server
+        layout: even-vertical
+        panes:
+          - command: npm run dev
+          - command: tail -f logs.txt
+```
+### Supported Layouts
+ - tiled : Panes are arranged in a grid.
+ - even-horizontal : Panel are arranged horizontally with equal width.
+ - even-vertical : Panel are arranged horizontally with equal height.
+ - main-horizontal : Panel are arranged horizontally with equal height but the first index, this will occupy half of the screen.
+ - main-vertical : Panel are arranged horizontally with equal width but the first index, this will occupy half of the screen.
+
+
+## Configuration ⚙️
 
 All configurations will be sourced in `YAML` format under `~/.config/zmux/` directory.
 
@@ -57,31 +138,38 @@ You can have multiple sessions pre-configured in each file:
   └── server.yaml    # Server management sessions
 ```
 
-For a basic session:
+Example session:
 
 ``` yaml
 sessions:
   project_a:
     root: ~/Projects/ProjectA/
     windows:
       - name: Editor
-        command: nvim .
-      - name: Terminal
-        command: ls
-  project_b:
-    root: ~/Projects/ProjectB/
-    windows:
-      - name: Code
-        command: nvim main.cpp
-      - name: compiling
-        command: echo hello
-      - name: README.md
-        command: nvim README.md
+        layout: tiled
+        panes:
+          - command: nvim .
+          - command: htop
+      - name: Server
+        layout: even-vertical
+        panes:
+          - command: npm run dev
+          - command: tail -f logs.txt
 ```
+### Key Fields 🔑
+- root: Root directory for the session.
+
+- windows: List of windows.
 
-Note: For now, there isn't layout and split panes but will be implemented.
+  - name: Window name.
 
-# Roadmap | TODO
+  - command: Command to run in the window (or pane).
+
+  - layout: (Optional) Layout for splits. Supported: tiled, even-horizontal, even-vertical. (v0.4.0+)
+
+  - panes: (Optional) List of panes for splits. Each pane can have a command. (v0.4.0+)
+
+## Roadmap | TODO 🗺️
 - [x] Create Session with `zmux <session_name>`
   - [x] Assign root directory
   - [x] Create Normal Windows and rename them
@@ -93,14 +181,31 @@ Note: For now, there isn't layout and split panes but will be implemented.
 - [x] Use multiple files instead of only `config.yaml`
 - [x] Configuration Checker
 - [x] Preview windows in fzf list
-- [ ] Splits
-  - [ ] Different Layouts
-- [ ] CI and testing to make sure it doesn't break anything
+- [x] Splits!
+  - [x] Different Layouts!
+- [x] CI and testing to make sure it doesn't break anything
 - [ ] Sugestions are welcome!
 
-# Changelog
+## Changelog 📜
+
+### [0.4.0] - 2024-01-31
+
+#### Added
+- Splits Support: Now you can configure splits (panes) within windows in your session configuration.
+- Improved Preview in `fzf`: The preview window now shows detailed information about splits.
+- Session Kill: Now you can kill a specific session with `zmux -k <session-name>` or kill the server `zmux -k all`
+
+#### Changed
+- Configuration Format: The `windows` section now supports a `panes` field for defining splits.
+- Error Handling: Improved error messages for invalid split configurations.
+
+#### Bugfix
+- Fixed an issue where the `root` directory was not being correctly set for panes.
+- Fixed a bug where the `fzf` preview window would not display pane information correctly.
+- Fixed an issue when export into a new file the `sessions:` header was missing
 
-### [0.3.2] - 2025-1-17
+
+### [0.3.2] - 2025-01-17
 
 ### Added
 
@@ -112,7 +217,8 @@ Note: For now, there isn't layout and split panes but will be implemented.
 
 - Correct the file list when creating new file through export, now also follows symbolic links.
 
-### [0.3.1] - 2025-1-16
+
+### [0.3.1] - 2025-01-16
 
 ### Added
 
@@ -127,13 +233,15 @@ Note: For now, there isn't layout and split panes but will be implemented.
 
 - Sometimes the yaml generated text was badly formatted.
 
-### [0.3] - 2025-1-3
+
+### [0.3] - 2025-01-03
 
 ### Added
 
 - Added support for multiple configuration files, now you can do it like this:
 - Added window Preview when seeing in `fzf list` , can press `ctrl-t` to toggle preview-window.
 
+
 ### [0.2] - 2024-12-29
 
 ### Added
@@ -150,6 +258,7 @@ Note: For now, there isn't layout and split panes but will be implemented.
 - Now `session_name` can only have alphanumeric, underscore and hyphen.
 - If there wasn't any sessions in config file `zmuz` didn't work.
 
+
 ### [0.1.1] - 2024-12-22
 
 ### Bugfix
@@ -158,6 +267,7 @@ Note: For now, there isn't layout and split panes but will be implemented.
 - Fixed error when user inserted an non existent and not configured session name.
 - Root folder wasn't being set correctly.
 
+
 ### [0.1] - 2024-12-14
 
 ### Added
@@ -167,5 +277,5 @@ Note: For now, there isn't layout and split panes but will be implemented.
 - It fetch the preconfigured sessions in '~/.config/zmux/config.yaml'
 - When Selected, it create/opens the session.
 
-## License
+## License 📄
 MIT