patx/wred

Update docs to install Wred from PyPI with uv

Commit e638cd9 · patx · 2026-10-13T03:24:55-04:00

Changeset: e638cd92786ba97f65a90abee4eec0b4929fbe68
Parents: bfb9df0031fe7d4efaf7c208100ec869e201b235

Comments

No comments yet.

Diff

diff --git a/README.md b/README.md
index 16426fe..5bd026a 100644
--- a/README.md
+++ b/README.md
@@ -26,16 +26,18 @@ them everyone else's dependency. Wred doesn't need to know they exist.
 
 ## Use it
 
-Python 3.11+. Clone the repo, then install it:
+Python 3.11+. Install from PyPI:
 
 Procure your goods, yeah, use `uv` not `pip`, its 2026:
 
 ```bash
-$ git clone https://gitman.io/git/patx/wred
-$ cd wred
-$ uv sync
+$ uv init my-app
+$ cd my-app
+$ uv add wred
 ```
 
+Already have a uv project? Just run `uv add wred`. Granian and orjson come with it.
+
 Put this in your pipe (`app.py`):
 
 ```python
@@ -192,8 +194,12 @@ aren't caught by Wred; fix your shit or handle them in your application.
 The [`example_app`](https://gitman.io/patx/wred/src/example_app) notebook demonstrates signup, login,
 refresh cookies, logout, protected endpoints, note CRUD, and rate limiting.
 Those features belong to the example, not the framework.
+Clone the repository to try it:
 
 ```bash
+git clone https://gitman.io/git/patx/wred
+cd wred
+uv sync
 uv run granian --interface asginl --workers 1 example_app.app:app
 ```
 
diff --git a/docs/index.html b/docs/index.html
index d7740e8..856bce7 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -50,9 +50,9 @@
     </header>
     <section class="terminal-track" aria-label="Scroll through installation and example files">
       <div class="terminal">
-      <pre id="source" aria-label="Installation and example files"><code>$ git clone https://gitman.io/git/patx/wred
-$ cd wred
-$ uv sync
+      <pre id="source" aria-label="Installation and example files"><code>$ uv init my-app
+$ cd my-app
+$ uv add wred
 
 $ cat &gt; app.py &lt;&lt;'EOF'
 from wred import App