docs: Update README.

Author: dgrah50

.cursor/rules/python.mdc

@@ -1,5 +1,12 @@
 docs/source
 
+# Editor configs
+.cursor/
+.vscode/
+
+# Ruff cache
+.ruff_cache/
+
 # From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
 
 # Byte-compiled / optimized / DLL files

.gitignore

@@ -18,4 +18,4 @@ COPY . /app
 # Sync the project
 RUN uv sync --frozen
 
-CMD [ "python", "stream_viz/foo.py" ]
+CMD ["uv", "run", "uvicorn", "stream_viz.main:app", "--host", "0.0.0.0", "--port", "8585"]

Dockerfile

@@ -1,69 +1,76 @@
 # stream-viz
 
-[![Release](https://img.shields.io/github/v/release/dgrah50/stream-viz)](https://img.shields.io/github/v/release/dgrah50/stream-viz)
-[![Build status](https://img.shields.io/github/actions/workflow/status/dgrah50/stream-viz/main.yml?branch=main)](https://github.com/dgrah50/stream-viz/actions/workflows/main.yml?query=branch%3Amain)
-[![codecov](https://codecov.io/gh/dgrah50/stream-viz/branch/main/graph/badge.svg)](https://codecov.io/gh/dgrah50/stream-viz)
-[![Commit activity](https://img.shields.io/github/commit-activity/m/dgrah50/stream-viz)](https://img.shields.io/github/commit-activity/m/dgrah50/stream-viz)
-[![License](https://img.shields.io/github/license/dgrah50/stream-viz)](https://img.shields.io/github/license/dgrah50/stream-viz)
+A real-time streaming SQL visualization tool. Write SQL queries against a [Timeplus Proton](https://github.com/timeplus-io/proton) streaming database and instantly see results rendered as live-updating data grids and charts powered by [Perspective](https://perspective.finos.org/).
 
-A web app for visualizing streaming data
+The app provides a split-pane interface: a SQL editor on top (with table/column autocomplete) and a Perspective data viewer on the bottom. Run a streaming query and watch the results flow in and update in real time -- including support for tumbling window aggregations and filtered streams.
 
-- **Github repository**: <https://github.com/dgrah50/stream-viz/>
-- **Documentation** <https://dgrah50.github.io/stream-viz/>
+## Architecture
 
-## Getting started with your project
+- **Backend** (Python/FastAPI): WebSocket server that executes streaming SQL queries against Timeplus/Proton, manages query lifecycle (start/stop/restart), and feeds results into Perspective tables over a second WebSocket channel.
+- **Frontend** (React/TypeScript/Vite): CodeMirror-based SQL editor with schema-aware autocomplete, connected to Perspective viewers for live data grids and D3 charts. State managed with Zustand.
 
-### 1. Create a New Repository
+## Prerequisites
 
-First, create a repository on GitHub with the same name as this project, and then run the following commands:
+- Python 3.9+
+- [uv](https://docs.astral.sh/uv/) (Python package manager)
+- Node.js 18+
+- A running [Timeplus Proton](https://github.com/timeplus-io/proton) instance
 
-```bash
-git init -b main
-git add .
-git commit -m "init commit"
-git remote add origin git@github.com:dgrah50/stream-viz.git
-git push -u origin main
-```
+## Getting Started
 
-### 2. Set Up Your Development Environment
+### Timeplus Proton
 
-Then, install the environment and the pre-commit hooks with
+Start a Proton instance with Docker:
 
 ```bash
-make install
+docker run -d --name proton -p 8463:8463 -p 3218:3218 d.timeplus.com/timeplus-io/proton:latest
 ```
 
-This will also generate your `uv.lock` file
+### Backend
 
-### 3. Run the pre-commit hooks
+```bash
+# Install dependencies
+uv sync
+
+# Run the server
+uv run python -m stream_viz.main
+```
 
-Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:
+The backend runs on `http://localhost:8585` by default.
+
+### Frontend
 
 ```bash
-uv run pre-commit run -a
+cd frontend
+npm install
+npm run dev
 ```
 
-### 4. Commit the changes
+### Configuration
 
-Lastly, commit the changes made by the two steps above to your repository.
+Create a `.env` file in the project root:
 
-```bash
-git add .
-git commit -m 'Fix formatting issues'
-git push origin main
+```env
+TIMEPLUS_HOST=localhost
+TIMEPLUS_PORT=8463
+DEBUG=true
 ```
 
-You are now ready to start development on your project!
-The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
+See `src/stream_viz/config.py` for all available settings.
 
-To finalize the set-up for publishing to PyPI, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
-For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
-To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).
+## Development
 
-## Releasing a new version
+```bash
+# Install dev dependencies and pre-commit hooks
+make install
 
+# Run linting and type checks
+make check
 
+# Run tests
+make test
+```
 
----
+## License
 
-Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
+MIT