summaryrefslogtreecommitdiff
path: root/plugins
diff options
context:
space:
mode:
authorAlejandro Gastón Alvarez <alegasalv@gmail.com>2022-03-29 17:23:45 +0200
committerGitHub <noreply@github.com>2022-03-29 17:23:45 +0200
commit93435bff4947ca0855d4d8ecc4786877578f0dd3 (patch)
tree36b56dd46e20750bc0326e22d9ebf61e40b46bbf /plugins
parentd77ac9e29d6079a7ecd561417772c3218aac94b1 (diff)
downloadzsh-93435bff4947ca0855d4d8ecc4786877578f0dd3.tar.gz
zsh-93435bff4947ca0855d4d8ecc4786877578f0dd3.tar.bz2
zsh-93435bff4947ca0855d4d8ecc4786877578f0dd3.zip
docs(bazel): improve plugin README (#10806)
Diffstat (limited to 'plugins')
-rw-r--r--plugins/bazel/README.md17
1 files changed, 13 insertions, 4 deletions
diff --git a/plugins/bazel/README.md b/plugins/bazel/README.md
index e5ffe6ea1..fc375d219 100644
--- a/plugins/bazel/README.md
+++ b/plugins/bazel/README.md
@@ -1,5 +1,14 @@
-## Bazel autocomplete plugin
+# Bazel plugin
-A copy of the completion script from the
-[bazelbuild/bazel](https://github.com/bazelbuild/bazel/master/scripts/zsh_completion/_bazel)
-git repo.
+This plugin adds completion for [bazel](https://bazel.build), an open-source build and
+test tool that scalably supports multi-language and multi-platform projects.
+
+To use it, add `bazel` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... bazel)
+```
+
+The plugin has a copy of [the completion script from the git repository][1].
+
+[1]: https://github.com/bazelbuild/bazel/blob/master/scripts/zsh_completion/_bazel