quickstart

README.md

@@ -35,11 +35,50 @@ space_ci:
       # Defaults to no storage (free).
 ---
 
-# Configure a CI for your Spaces 🚀
+# Listen to Pull Requests and start ephemeral Spaces on new PRs! 🚀
 
 **Gradio Space CI** is a plugin (and package) to create ephemeral Spaces for each PR opened on your Space repo.
 The goal is to foster community contributions by making the review process as lean as possible.
 
+## Quick start
+
+Configure *Gradio Space CI* in just 4 steps!
+
+1. Update your requirements.
+
+```bash
+# requirements.txt
+gradio-space-ci @ git+https://huggingface.co/spaces/Wauplin/gradio-space-ci@0.2.0
+```
+
+2. Set `HF_TOKEN` as a Space secret.
+3. Configure CI in your `README.md`.
+
+```yaml
+# README.md
+title: ...
+emoji: ...
+sdk: gradio
+space_ci:
+   trusted_authors:
+      - clefourrier
+   secrets:
+      - HF_TOKEN
+   hardware: cpu-basic
+   storage: null
+```
+
+4. Enable CI in `app.py`.
+
+```py
+# app.py
+from gradio_space_ci import enable_space_ci
+
+enable_space_ci()
+```
+
+And that's it! For more details, check out the [integration](#integration) section.
+
 ## Key features
 
 1. **Listen to Pull Requests**.