summaryrefslogtreecommitdiff
path: root/plugins/fbterm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/fbterm/README.md')
-rw-r--r--plugins/fbterm/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/fbterm/README.md b/plugins/fbterm/README.md
new file mode 100644
index 000000000..70ce56da8
--- /dev/null
+++ b/plugins/fbterm/README.md
@@ -0,0 +1,10 @@
+# fbterm
+
+This plugin automatically starts [fbterm](https://github.com/zhangyuanwei/fbterm)
+if on a real TTY (`/dev/tty*`).
+
+To use it, add `fbterm` to the plugins array of your zshrc file:
+
+```zsh
+plugins=(... fbterm)
+```