Update README.md

README.md

@@ -1,12 +1,35 @@
 ---
-title: Faq
-emoji: 🦀
-colorFrom: green
-colorTo: blue
+title: NeuroBERT-Tiny API
+emoji: 🤖
+colorFrom: blue
+colorTo: green
 sdk: docker
 app_port: 7860
-pinned: false
-license: mit
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# NeuroBERT-Tiny Masked Language Model API
+
+This Space hosts a FastAPI application that performs Masked Language Modeling using the [boltuix/NeuroBERT-Tiny](https://huggingface.co/boltuix/NeuroBERT-Tiny) model.
+
+## Endpoints:
+
+* **Health Check (GET /health):**
+    Returns a simple message to confirm the API is running.
+    Example: `curl https://brendon-ai-faq.hf.space/health`
+
+* **Predict (POST /):**
+    Accepts a JSON payload with a `text` field containing a sentence with `[MASK]` tokens.
+    Returns a list of top 5 predictions for each masked position.
+
+    Example `curl` request:
+    ```bash
+    curl -X POST \
+      -H "Content-Type: application/json" \
+      -d '{"text": "The quick brown fox jumps over the [MASK] dog."}' \
+      [https://brendon-ai-faq.hf.space/](https://brendon-ai-faq.hf.space/)
+    ```
+
+## Interactive API Documentation:
+You can find the full interactive API documentation at:
+* [Swagger UI](https://brendon-ai-faq.hf.space/docs)
+* [ReDoc](https://brendon-ai-faq.hf.space/redoc)