summaryrefslogtreecommitdiff
path: root/plugins/kate/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/kate/README.md')
-rw-r--r--plugins/kate/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/plugins/kate/README.md b/plugins/kate/README.md
new file mode 100644
index 000000000..aa2eaa3cc
--- /dev/null
+++ b/plugins/kate/README.md
@@ -0,0 +1,20 @@
+# Kate plugin
+
+This plugin adds aliases for the [Kate editor](https://kate-editor.org).
+
+To use it, add kate to the plugins array of your zshrc file:
+```
+plugins=(... kate)
+```
+
+## Aliases
+
+| Alias | Command | Description |
+|-------|------------------------|---------------------|
+| kate | `kate >/dev/null 2>&1` | Start kate silently |
+
+## Functions
+
+| Function | Description |
+|------------|------------------------------------------|
+| `kt <dir>` | Change to directory and start kate there |