From 97bcf2ee28a3a0cc1cf75d2acad9d88380cb3b7b Mon Sep 17 00:00:00 2001
From: Daylin Morgan <daylinmorgan@gmail.com>
Date: Mon, 19 Dec 2022 23:17:43 -0600
Subject: [PATCH] add more general readme info

---
 README.md | 32 ++++++++++++++++++++++++++++++++
 1 file changed, 32 insertions(+)

diff --git a/README.md b/README.md
index 505178f..2c77d29 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
 # Viv isn't venv
+
+## Setup
+Place this directory on the python path in your rc file.
+
+```sh
+export PYTHONPATH="$PYTHONPATH:$HOME/.viv/src"
+```
+
+Then in any python script with external dependencies you can add this line.
+
+```python
+__import__("viv").activate("click")
+```
+
+## Usage
+
+To temove all viv venvs:
+```sh
+viv remove $(viv list -q)
+```
+
+
+## TODO
+- [ ] add doc strings to `src/viv.py`
+- [ ] use config file (probably ini or json / could also allow toml for python>=3.11)
+- [ ] enable a garbage collection based on time or file existence (configurable)
+- [ ] unit tests
+
+## Alternatives
+
+- `pipx`
+- `pip-run`