1 files changed, 10 insertions, 0 deletions
diff --git a/plugins/poetry-env/README.md b/plugins/poetry-env/README.md
new file mode 100644
index 000000000..a7d16563e
--- /dev/null
+++ b/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)
+```