From 51f0eaad61d5870d990386ad8479bcd6a86108b6 Mon Sep 17 00:00:00 2001 From: Sukin Kumar K Date: Tue, 1 Oct 2019 16:43:18 +0530 Subject: [PATCH] Add README for thor and pip plugins (#8185) --- plugins/pip/README.md | 19 +++++++++++++++++++ plugins/thor/README.md | 10 ++++++++++ 2 files changed, 29 insertions(+) create mode 100644 plugins/pip/README.md create mode 100644 plugins/thor/README.md diff --git a/plugins/pip/README.md b/plugins/pip/README.md new file mode 100644 index 000000000..f07b5c058 --- /dev/null +++ b/plugins/pip/README.md @@ -0,0 +1,19 @@ +# pip plugin + +This plugin adds completion for [pip](https://pip.pypa.io/en/latest/), +the Python package manager. + +To use it, add `pip` to the plugins array in your zshrc file: + +```zsh +plugins=(... pip) +``` + +## pip cache + +The pip plugin caches the names of available pip packages from the PyPI index. +To trigger the caching process, try to complete `pip install`, +or you can run `zsh-pip-cache-packages` directly. + +To reset the cache, run `zsh-pip-clear-cache` and it will be rebuilt next +the next time you autocomplete `pip install`. diff --git a/plugins/thor/README.md b/plugins/thor/README.md new file mode 100644 index 000000000..09c705d9a --- /dev/null +++ b/plugins/thor/README.md @@ -0,0 +1,10 @@ +# Thor plugin + +This plugin adds completion for [Thor](http://whatisthor.com/), +a ruby toolkit for building powerful command-line interfaces. + +To use it, add `thor` to the plugins array in your zshrc file: + +```zsh +plugins=(... thor) +```