README.md

@@ -2,9 +2,11 @@
 
 A tiny Python package that steps through Grover’s Search algorithm and shows you, after each iteration:
 
-- A bar‐chart of amplitudes (or probabilities)
-- A sine‐curve of success‐probability vs. iteration
-- A geometric "rotation" on the unit circle
+- A bar‐chart of amplitudes (or probabilities)  
+- A sine‐curve of success‐probability vs. iteration  
+- A geometric "rotation" on the unit circle  
+
+Choose between a Matplotlib-based CLI or an optional DearPyGui GUI (WIP).
 
 ---
 
@@ -14,37 +16,69 @@ A tiny Python package that steps through Grover’s Search algorithm and shows y
 
 ## Installation
 
-### Using [uv](https://docs.astral.sh/uv/)/[uvx](https://docs.astral.sh/uv/guides/tools/)
+### Via [pipx](https://pipx.pypa.io/stable/installation/)
+
+Basic (CLI only):
+
+```bash
+pipx install grovers-visualizer
+grovers-visualizer 1111
+```
+
+With the optional DearPyGui UI (WIP):
+
+```bash
+pipx "grovers-visualizer[ui]"
+grovers-visualizer --ui
+```
+
+### Via [uvx](https://docs.astral.sh/uv/guides/tools/)
+
+Basic (CLI only):
 
 ```bash
 uvx grovers-visualizer 1111
 ```
 
-### Using [pip](https://pypi.org/project/pip/)/[pipx](https://pipx.pypa.io/stable/installation/)
+With the optional UI extra:
 
 ```bash
-pip grovers-visualizer
-# or
-pipx grovers-visualizer # (recommended)
-
-# and then run
-grovers-visualizer
+uvx "grovers-visualizer[ui]" --ui
 ```
 
 ---
 
 ## Usage
 
-### Flags
+### CLI Mode
 
-- `TARGET`  
- Target bit‐string (e.g. `010`). Length also determines number of qubits.  
-- `-i, --iterations ITERATIONS`  
- Max iterations; `0` means use the optimal $\lfloor\frac\pi4\sqrt{2^n}\rfloor$.  
-- `-s, --speed SPEED`  
+Flags:
+
+• `-t, --target`  
+ Target bit‐string (e.g. `010`). Length determines number of qubits.  
+• `-s, --speed`  
  Delay between iterations (seconds). Default `0.5`.  
-- `-p, --phase PHASE`  
-  The phase $\psi$ (in radians) used for both the oracle and diffusion steps. Defaults to $\pi$ (i.e. a sign-flip, $e^{i\pi}=-1$).
+• `-i, --iterations`  
+ Max iterations; `0` means use the optimal $\lfloor\frac\pi4\sqrt{2^n}\rfloor$.  
+• `--ui`  
+ Launch the optional DearPyGui GUI (requires the `[ui]` extra) (WIP).
+
+### GUI Mode (WIP)
+
+If you installed with `"[ui]"`, launch the DearPyGui window:
+
+```
+grovers-visualizer --ui
+```
+
+In the UI you can:
+
+- Set number of qubits  
+- Enter the target bit‐string  
+- Choose max iterations or leave at 0 for optimal  
+- Control the animation speed  
+
+Hit **Start** to watch the bar chart, sine plot, and rotation‐circle update in real time.
 
 ---
 

uv.lock

@@ -155,7 +155,7 @@ wheels = [
 
 [[package]]
 name = "grovers-visualizer"
-version = "0.5.0"
+version = "0.4.2"
 source = { editable = "." }
 dependencies = [
     { name = "numpy" },