Update README.md

README.md

@@ -11,9 +11,45 @@ pinned: false
 short_description: Streamlit template space
 ---
 
-# Welcome to Streamlit!
+---
+title: Snippet Generator
+emoji: ✂️
+colorFrom: blue
+colorTo: purple
+sdk: streamlit
+sdk_version: 1.28.0
+app_file: app.py
+pinned: false
+license: mit
+---
+
+# ✂️ Snippet Generator
+
+Recreates Google Vertex AI / Gemini grounding-style extractive snippets.
+
+## How it works
+
+1. **Sentence Segmentation** - Splits document on sentence boundaries and newlines, filters noise (URLs, questions, low-alpha content)
+2. **Cross-Encoder Scoring** - Uses `cross-encoder/ms-marco-electra-base` to score query-sentence relevance
+3. **Budget Selection** - Picks top-scoring sentences within character/count limits
+4. **Document-Order Stitching** - Reassembles in original order with `...` for gaps
+
+## Model
+
+Uses [MS MARCO Cross-Encoder](https://huggingface.co/cross-encoder/ms-marco-electra-base) trained on search relevance data - the same task as snippet generation.
+
+## Usage
+
+1. Enter a search query
+2. Paste document content
+3. Adjust settings (max chars, max sentences)
+4. Click "Generate Snippet"
+
+## Example
 
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
+**Query:** `best prostate cancer treatment in the world`
 
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
+**Output:**
+```
+This makes Asklepios one of the best prostate cancer treatment centers for foreigners. ... Spain is a leader in prostate cancer treatment, with top clinics like Centro Médico Teknon, Quironsalud Madrid, and Hospital Quiron Barcelona. ...
+```