Create README.md

README.md

@@ -0,0 +1,40 @@
+## Description
+
+Afroscope is a MODEL_TYPE (e.g., FastText / Transformer) language identification (LID) model that supports more than N_LABELS labels.
+
+**Latest:** MODEL_NAME is now updated to VERSION. VERSION supports N_LABELS labels (LABEL_FORMAT_HERE).
+
+For more details on the supported languages and performance, as well as significant changes from previous versions, please refer to LINK_HERE.
+
+- **Demo:** huggingface
+- **Repository:** github
+- **Paper:** paper (VENUE YEAR)
+- **Point of Contact:** EMAIL@DOMAIN.COM
+
+---
+
+## How to use
+
+Here is how to use this model to detect the language of a given text:
+
+```python
+import fasttext
+from huggingface_hub import hf_hub_download
+
+# model.bin is the latest version always
+model_path = hf_hub_download(repo_id="ORG_OR_USER/MODEL_NAME", filename="model.bin")
+
+model = fasttext.load_model(model_path)
+model.predict("Hello, world!")
+```
+
+## Citation
+
+```bibtex
+@article{kwon2026afroscope,
+  title={AfroScope: A Framework for Studying the Linguistic Landscape of Africa},
+  author={Kwon, Sang Yun and Elmadany, AbdelRahim and Abdul-Mageed, Muhammad},
+  journal={arXiv preprint arXiv:2601.13346},
+  year={2026}
+}
+```