From 93435bff4947ca0855d4d8ecc4786877578f0dd3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alejandro=20Gast=C3=B3n=20Alvarez?= Date: Tue, 29 Mar 2022 17:23:45 +0200 Subject: [PATCH] docs(bazel): improve plugin README (#10806) --- plugins/bazel/README.md | 17 +++++++++++++---- 1 file 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