From 032e23af95a5acaf49f7d827f387e76975803569 Mon Sep 17 00:00:00 2001
From: Daylin Morgan <daylinmorgan@gmail.com>
Date: Tue, 9 Jan 2024 01:41:34 -0600
Subject: [PATCH] docs: finish updating docs

---
 README.md     | 29 +++++++++++++++++++++++++----
 docs/index.md |  1 -
 2 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 5a3aab5..2bdbbbe 100644
--- a/README.md
+++ b/README.md
@@ -44,6 +44,16 @@ while still unleashing the full power of Python scripting with its entire ecosys
 
 For that reason, any usage of the CLI can be accomplished using a remote copy as seen in the below install command.
 
+
+`Viv` is a standalone dependency-free `venv` creator (just needs python + pip).
+`Viv` helps you ignore silly things like managing temporary or rarely used virtual environments,
+while still unleashing the full power of python scripting with it's entire ecosystem at your disposal.
+
+`Viv`'s uncompromising insistence on portability means that it will always,
+only use the standard library and never exceed a single script.
+
+See the [documentation](https://viv.dayl.in/viv.py) or the [examples](https://github.com/daylinmorgan/viv/tree/main/examples) to get started.
+
 ## Setup
 
 Run the below command to install `viv`.
@@ -74,10 +84,24 @@ Placing it in its own virtual environment or installing in a user site directory
 In any Python script with external dependencies you can add this line
 to automate `vivenv` creation and installation of dependencies.
 
+As a cli:
+
+```sh
+viv run frogmouth -- gh daylinmorgan/viv
+```
+
+As a python module:
+
 ```python
 __import__("viv").use("click")
 ```
 
+As an app installer:
+
+```sh
+viv shim ruff
+```
+
 To remove all `vivenvs` you can use the below command:
 
 ```sh
@@ -89,11 +113,11 @@ To remove `viv` altogether you can use the included `purge` command:
 ```sh
 python3 <(curl -fsSL viv.dayl.in/viv.py) manage purge
 ```
+
 ## Equivalent commands from alternatives
 
 ### [pip-run](https://github.com/jaraco/pip-run)
 
-
 ```sh
 pip-run cowsay -- -m cowsay "moove over, pip-run"
 python3 <(curl -fsSL viv.dayl.in/viv.py) run cowsay -- "moove over, pip-run"
@@ -132,9 +156,6 @@ for output of the below command.
 python3 <(curl -fsSL viv.dayl.in/viv.py) shim black -o ./black --standalone --freeze
 ```
 
-
-[^1]: You do need to have `pip` but surely you have `pip` already.
-
 [conda-shield]: https://img.shields.io/conda/vn/conda-forge/viv
 [conda-url]: https://anaconda.org/conda-forge/viv
 [pypi-shield]: https://img.shields.io/pypi/v/viv
diff --git a/docs/index.md b/docs/index.md
index 40d2a79..3171b64 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -26,7 +26,6 @@ while still unleashing the full power of python scripting with it's entire ecosy
 `Viv`'s uncompromising insistence on portability means that it will always,
 only use the standard library and never exceed a single script.
 
-Documentation is currently a WIP please see the [cli reference](./cli.md) and the [README](https://github.com/daylinmorgan/viv)
 
 ```{toctree}
 :hidden: