summaryrefslogtreecommitdiff
path: root/home/.oh-my-zsh/plugins/poetry-env/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'home/.oh-my-zsh/plugins/poetry-env/README.md')
-rw-r--r--home/.oh-my-zsh/plugins/poetry-env/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/home/.oh-my-zsh/plugins/poetry-env/README.md b/home/.oh-my-zsh/plugins/poetry-env/README.md
new file mode 100644
index 0000000..bd99d2a
--- /dev/null
+++ b/home/.oh-my-zsh/plugins/poetry-env/README.md
@@ -0,0 +1,10 @@
+# Poetry Environment Plugin
+
+This plugin automatically changes poetry environment when you cd into or out of the project directory.
+Note: Script looks for pyproject.toml file to determine poetry if its a poetry environment
+
+To use it, add `poetry-env` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... poetry-env)
+```