summaryrefslogtreecommitdiff
path: root/plugins/docker
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-10-19 17:30:04 +0200
committerGitHub <noreply@github.com>2019-10-19 17:30:04 +0200
commitbd9cd052f156f606a8f9ccccfeacf3125d06fd91 (patch)
treea1330612d8cddb27d3ea0c52d7be11c1667becba /plugins/docker
parent74165aba4ad500e6467973c5037e1379c55e9560 (diff)
parentf48a40ee91b48ca78703395e07aba5b2dd9e3c97 (diff)
downloadzsh-bd9cd052f156f606a8f9ccccfeacf3125d06fd91.tar.gz
zsh-bd9cd052f156f606a8f9ccccfeacf3125d06fd91.tar.bz2
zsh-bd9cd052f156f606a8f9ccccfeacf3125d06fd91.zip
docker: reformat README (#8286)
Diffstat (limited to 'plugins/docker')
-rw-r--r--plugins/docker/README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/plugins/docker/README.md b/plugins/docker/README.md
index e91798485..4d9f3ae9b 100644
--- a/plugins/docker/README.md
+++ b/plugins/docker/README.md
@@ -1,5 +1,11 @@
-## Docker autocomplete plugin
+# Docker plugin
-A copy of the completion script from the
-[docker/cli](https://github.com/docker/cli/blob/master/contrib/completion/zsh/_docker)
-git repo.
+This plugin adds auto-completion for [docker](https://www.docker.com/).
+
+To use it add `docker` to the plugins array in your zshrc file.
+```zsh
+plugins=(... docker)
+```
+
+A copy of the completion script from the docker/cli git repo:
+https://github.com/docker/cli/blob/master/contrib/completion/zsh/_docker