summaryrefslogtreecommitdiff
path: root/plugins/bwana/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/bwana/README.md')
-rw-r--r--plugins/bwana/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/plugins/bwana/README.md b/plugins/bwana/README.md
new file mode 100644
index 000000000..dd4fe9f9c
--- /dev/null
+++ b/plugins/bwana/README.md
@@ -0,0 +1,12 @@
+# Bwana
+
+This plugin provides a function to open `man` pages directly with [Bwana](https://www.bruji.com/bwana/).
+
+To use it add bwana to the plugins array in your zshrc file.
+
+```bash
+plugins=(... bwana)
+```
+
+The `bwana` function opens the man page of the passed argument in the Bwana app.
+For example: `bwana ln` opens the man page for `ln` in Bwana.