feat: implement new features for version 0.2.0 (#1)

Signed-off-by: yaroslavborbat <[email protected]>

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "zellij-bookmarks"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 publish = false
 
@@ -9,4 +9,5 @@ owo-colors = "4.1.0"
 serde = { version = "1.0.214", features = ["derive"] }
 serde_yaml = "0.9.34"
 zellij-tile = "0.41.2"
-zellij-utils = "0.41.2"
+num_enum = "0.7.3"
+handlebars = "6.2.0"

README-old.md

@@ -0,0 +1,63 @@
+# Version `0.1.0`
+
+## 📖 Usage
+- **Navigation**: Use `Up` and `Down` to cycle through the bookmarks or labels list.
+- **Insert Command**: Press `Enter` to paste the selected bookmark into the terminal.
+- **Search**: Start typing to filter the list based on the current mode.
+- **Exit**: Press `Esc` or `Ctrl + c` to exit the plugin.
+- **Edit Bookmarks**: Press `Ctrl + e` to open the bookmark configuration file for editing.
+- **Reload Configuration**: Press `Ctrl + r` to reload bookmarks after making changes.
+- **Filter Modes**: Use `Ctrl + f` to toggle filter modes (available only in bookmark mode).
+- **Switch Modes**: Press `Ctrl + l` to toggle between Bookmarks and Labels modes.
+- **View Commands**: Press `Ctrl + v` to display the command associated with the bookmark (only for bookmarks).
+- **Usage Info**: Press `Ctrl + u` to display usage instructions.
+
+---
+## ⚙️ Configuration
+### Keybinding
+
+Add the following configuration to your [Zellij config](https://zellij.dev/documentation/configuration.html) inside the [keybinds](https://zellij.dev/documentation/keybindings.html) section:
+
+```kdl
+shared_except "locked" {
+    bind "Alt M" {
+        LaunchOrFocusPlugin "file:~/.config/zellij/plugins/zellij-bookmarks.wasm" {
+            floating true
+            cwd "/home/<USER>/.config/zellij/"
+        };
+    }
+}
+```
+> **Note**: You likely already have a `shared_except "locked"` section in your configuration. Add the `bind` command there.
+
+> **Note**: Make sure to replace \<USER\> in the cwd path with your actual username.
+
+#### Parameters
+
+- **`exec`**: *(default: `false`)* - If `true`, the command will execute immediately after pressing `Enter`. This can be overridden per bookmark.
+- **`ignore_case`**: *(default: `true`)* - When filtering, ignores case sensitivity in both the filter string and bookmark/label names.
+- **`cwd`**: *(REQUIRED)* - The absolute path where your bookmarks file will be stored.
+- **`filename`**: *(default: `.zellij_bookmarks.yaml`)* - The name of the bookmarks file.
+
+### Bookmarks Configuration
+
+The bookmarks configuration is a YAML file that defines your bookmarks. Each bookmark has the following fields:
+
+- **`name`**: A human-readable name for the bookmark.
+- **`command`**: The command to be inserted into the terminal.
+- **`exec`**: *(optional)* Whether the command should be executed immediately.
+- **`label`**: *(optional)* A category or tag for the bookmark.
+
+#### Example Configuration:
+```yaml
+bookmarks:
+- name: "Bookmark #1"
+  command: "echo 'Your command #1'"
+  exec: true
+  label: echo
+- name: "Bookmark #2"
+  command: |
+    echo 'Your command #2'
+  exec: false
+  label: echo
+```