summaryrefslogtreecommitdiff
path: root/plugins/cabal/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/cabal/README.md')
-rw-r--r--plugins/cabal/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/plugins/cabal/README.md b/plugins/cabal/README.md
new file mode 100644
index 000000000..b1106c40f
--- /dev/null
+++ b/plugins/cabal/README.md
@@ -0,0 +1,9 @@
+# Cabal
+
+This plugin provides completion for [Cabal](https://www.haskell.org/cabal/), a build tool for Haskell. It
+also provides a function `cabal_sandbox_info` that prints whether the current working directory is in a sandbox.
+
+To use it, add cabal to the plugins array of your zshrc file:
+```
+plugins=(... cabal)
+```