Create README.md

README.md

@@ -1,13 +1,22 @@
----
-title: Circle Ci Viz
-emoji: 📊
-colorFrom: purple
-colorTo: indigo
-sdk: gradio
-sdk_version: 5.49.1
-app_file: app.py
-pinned: false
-short_description: Helps visualize cricle ci tests
----
-
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# CircleCI Test Collection Helper Space
+
+This directory contains the code for a Hugging Face Space hosted at
+[`transformers-community/circleci-test-collection-helper`](https://huggingface.co/spaces/transformers-community/circleci-test-collection-helper).
+
+The Space reads aggregated CircleCI reports from the dataset
+[`transformers-community/circleci-test-results`](https://huggingface.co/datasets/transformers-community/circleci-test-results)
+and exposes a lightweight UI to search by repository, pull request number, or commit SHA.
+
+## Environment variables
+
+- `CIRCLECI_RESULTS_DATASET_ID` (optional): override the dataset to query. Defaults to
+  `transformers-community/circleci-test-results`.
+
+## Local development
+
+```bash
+pip install -r requirements.txt
+python app.py
+```
+
+Then open the printed local Gradio URL to inspect the UI.