Update README.md

README.md

@@ -1,6 +1,6 @@
 ---
 title: SPM
-emoji: 🐠
+emoji: 🚀
 colorFrom: green
 colorTo: pink
 sdk: gradio
@@ -11,4 +11,30 @@ license: mit
 short_description: Shuffle PatchMix Augmentation
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# Shuffle PatchMix (SPM) — Hugging Face Space
+
+A minimal interactive demo for SPM-style augmentation. Upload an image (or a .zip of images), set **grid size (N×N)**, and download the augmented outputs.
+
+GitHub repo: https://github.com/PrasannaPulakurthi/SPM
+
+## Parameters
+- **Grid (N×N):** Choose one of **2×2, 4×4, 8×8, 16×16**. The image is cropped (top-left) so its width and height are divisible by N.
+- **Mix probability:** Per-patch probability to mix original and a shuffled patch.
+- **Beta α, β:** Shape parameters for a single per-image alpha sampled from Beta(α,β).
+- **Seed:** Optional deterministic seed.
+
+## Batch Mode
+Upload a `.zip` containing images (`.png`, `.jpg`, `.jpeg`). The app returns a `.zip` of augmented results with the same folder structure.
+
+## Notes
+- This uses a **global** patch permutation and per-patch mixing with a **single** alpha per image (tweak in `spm.py` if you want per-patch alpha or different strategies).
+- If you want parity with a specific paper version, swap in your official implementation but keep `spm_augment(image, num_patches, mix_prob, beta_a, beta_b, seed)`.
+
+## Local Development
+```bash
+pip install -r requirements.txt
+python app.py
+```
+
+## License
+MIT