Flatten package layout and add Gitea CI

README.md

@@ -1,11 +1,15 @@
 # whisper-remote
 
-Two separate Python packages live in this repo:
+A split repo for running the upstream `openai/whisper` CLI remotely.
+
+Two separate Python packages live here:
 
 - `backend/`: FastAPI wrapper around the upstream `whisper` CLI
 - `cli/`: local `whisper-remote` command that forwards work to the remote API
 
-## Backend
+The repo also includes a Gitea Actions workflow at `.gitea/workflows/ci.yml` that tests and builds both packages on pushes to `main` and pull requests.
+
+## Backend setup
 
 ```bash
 cd backend
@@ -15,13 +19,34 @@ uvicorn whisper_remote_backend.server:app --host 0.0.0.0 --port 8000
 
 The backend machine must already have the upstream `whisper` CLI available on `PATH`.
 
-## CLI
+## CLI setup
 
 ```bash
 cd cli
 pip install -e .
+whisper-remote ./audio.mp3 --model base --language en --output-format txt
+```
+
+PowerShell:
+
+```powershell
+$env:WHISPER_REMOTE = "http://your-server:8000"
+whisper-remote .\audio.mp3 --model base --language en --output-format txt
+```
+
+Bash:
+
+```bash
 export WHISPER_REMOTE=http://your-server:8000
 whisper-remote ./audio.mp3 --model base --language en --output-format txt
 ```
 
-By default the CLI prints the transcript to stdout. Use `--to-file` to save the returned transcript locally.
+## Supported v1 options
+
+- model selection
+- language forwarding
+- transcript output formats: `txt`, `vtt`, `srt`, `tsv`, `json`
+- file upload to the backend
+- backend-side cleanup of uploaded and generated files after each request
+
+By default the CLI prints the returned transcript to stdout. Use `--to-file` to save it locally.