Create README.md

README.md

@@ -1,12 +1,51 @@
 ---
-title: Gigscan
-emoji: 🌖
-colorFrom: pink
-colorTo: yellow
+title: GigScan
+emoji: 📸
+colorFrom: indigo
+colorTo: purple
 sdk: docker
 pinned: false
-license: mit
-short_description: Test of gigscan for HF Hackathon
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# 📸 GigScan — Snap a Gig Poster, Get a Calendar Invite
+
+**Build Small Hackathon 2025 — Backyard AI Track**
+
+Ever snapped a photo of a gig poster pinned to a wall and then forgotten to add it to your calendar? GigScan fixes that.
+
+Snap a photo of any live music poster and get an instant calendar invite — .ics file for Apple/Outlook, or one-tap Google Calendar link. No typing required.
+
+---
+
+## 🏗️ How It Works
+
+1. **Upload or snap** a photo of a gig poster
+2. **MiniCPM-V 1.3B** (fine-tuned on 276 gig posters) extracts structured event data
+3. **llama.cpp** runs the model locally in 4-bit quantized GGUF format
+4. **GBNF grammar** constrains output to valid JSON — zero malformed responses
+5. **Calendar invite** generated as .ics + Google Calendar link
+
+---
+
+## 🎯 Badges
+
+| Badge | Status |
+|---|---|
+| 🎯 Well-Tuned | ✅ Fine-tuned MiniCPM-V 4.6 on custom poster dataset |
+| 🦙 Llama Champion | ✅ Runs entirely via llama.cpp runtime |
+| 🔌 Off the Grid | ✅ Zero cloud APIs — model runs locally in the Space |
+| 🎨 Off-Brand | ✅ Clean mobile-first UI built with Gradio |
+| 📡 Sharing is Caring | ✅ Inference traces logged to HF dataset |
+| 📓 Field Notes | ✅ [Blog post](LINK_TBD) |
+
+---
+
+## 🔗 Links
+
+- **Model:** [kieranadair/gigscan-minicpm-v](https://huggingface.co/kieranadair/gigscan-minicpm-v)
+- **GGUF:** [kieranadair/gigscan-minicpm-v-gguf](https://huggingface.co/kieranadair/gigscan-minicpm-v-gguf)
+- **Dataset:** [kieranadair/gigscan-training](https://huggingface.co/datasets/kieranadair/gigscan-training)
+
+---
+
+Built by [kieranadair](https://huggingface.co/kieranadair) for the Build Small Hackathon 2026.