update readme

README.md

@@ -13,4 +13,50 @@ hf_oauth_scopes:
  - inference-api
 ---
 
-An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
+# 🀄 Chinese Idiom Finder  
+
+An interactive app to discover and learn **Chinese idioms (成语, 俗语, 谚语)**.  
+Given a situation, the app suggests a relevant idiom, provides **pinyin**, a **literal English translation**, and a **concise explanation**.  
+
+👉 Live Demo: [Chinese Idiom Finder on Hugging Face Spaces](https://huggingface.co/spaces/chinese-enthusiasts/idiom-finder)  
+
+---
+
+## ✨ Features  
+- 🔍 **Idiom generation** using an LLM (OpenAI-compatible model).  
+- ✅ **Idiom verification** using:  
+  - [ChID dataset](https://arxiv.org/abs/1906.01265) (Chinese Idiom Dataset)  
+  - CC-CEDICT (open Chinese–English dictionary)  
+  - Wiktionary (fallback)  
+
+---
+
+## 🚀 How It Works  
+1. User inputs a situation (e.g. *“When you stay calm under pressure”*).  
+2. The LLM generates an idiom suggestion.  
+3. The idiom is verified against datasets/dictionaries.  
+4. Output includes:  
+   - Idiom in Chinese  
+   - Pinyin  
+   - Literal translation  
+   - Concise explanation  
+
+---
+
+## 🛠️ Tech Stack  
+- [Gradio](https://www.gradio.app/) (frontend)  
+- Hugging Face Spaces (deployment)  
+- OpenAI-compatible LLM API  
+- Python (requests, pypinyin, etc.)  
+
+---
+
+## 🖥️ Local Development  
+
+Clone the repo and run locally:  
+
+```bash
+git clone https://huggingface.co/spaces/chinese-enthusiasts/idiom-finder
+cd idiom-finder
+pip install -r requirements.txt
+python app.py