From efafef8495f030501e0df59ccb76a598bbce3ae1 Mon Sep 17 00:00:00 2001
From: Marc Cornellà <marc@mcornella.com>
Date: Fri, 9 Aug 2024 09:44:46 +0200
Subject: docs: improve several plugin READMEs and add one for `ssh` plugin

---
 plugins/ssh/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 plugins/ssh/README.md

(limited to 'plugins/ssh/README.md')

diff --git a/plugins/ssh/README.md b/plugins/ssh/README.md
new file mode 100644
index 000000000..3dd32ec76
--- /dev/null
+++ b/plugins/ssh/README.md
@@ -0,0 +1,16 @@
+# ssh plugin
+
+This plugin provides host completion based off of your `~/.ssh/config` file, and adds
+some utility functions to work with SSH keys.
+
+To use it, add `ssh` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... ssh)
+```
+
+## Functions
+
+- `ssh_rmhkey`: remove host key from known hosts based on a host section name from `.ssh/config`.
+- `ssh_load_key`: load SSH key into agent.
+- `ssh_unload_key`: remove SSH key from agent.
-- 
cgit v1.2.3-70-g09d2