summaryrefslogtreecommitdiff
path: root/plugins/kitty/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/kitty/README.md')
-rw-r--r--plugins/kitty/README.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/plugins/kitty/README.md b/plugins/kitty/README.md
new file mode 100644
index 000000000..ec9e375de
--- /dev/null
+++ b/plugins/kitty/README.md
@@ -0,0 +1,23 @@
+# Kitty plugin
+
+This plugin adds a few aliases and functions that are useful for users of the [Kitty](https://sw.kovidgoyal.net/kitty/) terminal.
+
+To use it, add _kitty_ to the plugins array of your zshrc file:
+```
+plugins=(... kitty)
+```
+
+## Plugin commands
+
+* `kssh`
+ Runs a kitten ssh session that ensures your terminfo settings are copied
+ correctly to the remote hose.
+* `kssh-slow`
+ A slower form of `kssh` that should always work. Use this if `kssh` fails
+ to set terminfo correctly for you on the remote host.
+* `kitty-theme`
+ Browse and change the theme of your Kitty terminal.
+
+## Contributors
+
+- [Ian Chesal](https://github.com/ianchesal)