dotfiles

1 files changed, 28 insertions, 0 deletions

diff --git a/zsh/oh-my-zsh/plugins/pip/README.md b/zsh/oh-my-zsh/plugins/pip/README.md
new file mode 100644
index 0000000..88d8822
--- /dev/null
+++ b/zsh/oh-my-zsh/plugins/pip/README.md
@@ -0,0 +1,28 @@
+# 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`.
+
+## Aliases
+
+| Alias    | Description                                   |
+| :------- | :-------------------------------------------- |
+| pipreq   | Create requirements file                      |
+| pipir    | Install packages from `requirements.txt` file |
+| pipupall | Update all installed packages                 |
+| pipunall | Uninstall all installed packages              |