Update README.md

README.md

@@ -1,35 +1,37 @@
----
-language:
-- my
-- ar
-- en
-license: cc-by-nc-4.0
-pretty_name: Quran Burmese Word Alignment
-size_categories:
-- 10K<n<100K
-source_datasets:
-- original
-annotations_creators:
-- expert-generated
-task_categories:
-- translation
-- text-generation
-tags:
-- myanmar
-- burmese
-- arabic
-- english
-- quranwords
-- burmesewords
-- englishwords
----
+---
+language:
+- my
+- ar
+- en
+license: cc-by-nc-4.0
+pretty_name: Quran Burmese Word Alignment
+size_categories:
+- 100K<n<1M
+source_datasets:
+- original
+annotations_creators:
+- expert-generated
+task_categories:
+- translation
+- text-generation
+tags:
+- quran
+- quranic-arabic
+- myanmar
+- burmese
+- arabic
+- english
+- word-alignment
+- low-resource-language
+- islamic-studies
+---
 # Quran Burmese Word Alignment Dataset
 
 **Creator:** freococo  
 **License:** CC BY-NC 4.0  
 **Language:** Burmese (Myanmar), Arabic  
 **Format:** JSONL (one word per line)  
-**Current Version:** v1 (Surah 1–2)
+**Current Version:** v10 (Surah 1–114)
 
 ---
 
@@ -50,17 +52,38 @@ The dataset is designed for:
 ## 📦 Dataset Contents
 
 | File | Description |
-|----|----|
-| `q_v1.jsonl` | Word-level dataset covering **Surah 1 and Surah 2** |
+|------|-------------|
+| `q_v10.jsonl` | Complete Quran (Surah 1–114), word-by-word Burmese–Arabic alignment |
 
-**Statistics (v1):**
-- Surahs: 1–2
-- Total verses: 293
-- Total words: **10,874**
+**Statistics (v10):**
+- Surahs: 114
+- Total verses: **6,236**
+- Total words: **141,774**
 - Format: JSONL (1 word = 1 line)
 
 ---
 
+## 🧪 Usage Example
+
+```python
+from datasets import load_dataset
+
+# Load the dataset
+dataset = load_dataset(
+    "freococo/quran-burmese-word-alignment",
+    split="train"
+)
+
+# Inspect dataset
+print(dataset)
+print("Columns:", dataset.column_names)
+
+# Inspect a single word entry
+example = dataset[0]
+for k, v in example.items():
+    print(f"{k}: {v}")
+```
+
 ## 🧱 Data Schema (Canonical)
 
 Each line is a single JSON object with the following fields:
@@ -131,15 +154,12 @@ These rules ensure consistency, auditability, and model safety.
 
 ## 🔄 Versioning Plan
 
-The dataset is released incrementally to ensure stability and traceability.
-
 | Version | Coverage |
 |--------|----------|
-| `v1` | Surah 1–2 (released) |
-| `v2` | Additional surahs (planned) |
-| `v3` | Full Quran (planned) |
+| `v1` | Surah 1–2 |
+| `v10` | **Complete Quran (Surah 1–114)** |
 
-All future releases will **maintain backward compatibility** with earlier versions.
+All future releases will maintain backward compatibility.
 
 ---