Update README.md

README.md

@@ -1,10 +1,31 @@
----
-title: README
-emoji: 😻
-colorFrom: purple
-colorTo: red
-sdk: static
-pinned: false
----
-
-Edit this `README.md` markdown file to author your organization card.
+# The UniversalCEFR Data Directory
+
+UniversalCEFR is a largescale, multilingual, multidimensional dataset comprising of texts annotated according to the [CEFR (Common European Framework of Reference)](https://www.coe.int/en/web/common-european-framework-reference-languages/level-descriptions). The collection comprises of a total of **505,807 CEFR-labeled texts** annotated in **13 languages** in 4 script (Latin, Arabic, Devanagari, and Cyrillic).
+
+ - English (en)
+ - Spanish (es)
+ - German (de)
+ - Dutch (nl)
+ - Czech (cs)
+ - Italian (it)
+ - French (fr)
+ - Estonian (et)
+ - Portuguese (pt)
+ - Arabic (ar)
+ - Hindi (hi)
+ - Russian (ru)
+ - Welsh (cy)
+
+## UniversalCEFR Data Format / Schema
+To ensure interoperability, transformation, and machine readability, adopted **standardised JSON format** for each CEFR-labeled text. These fields include the source dataset, language, granularity (document, paragraph, sentence, discourse), production category (learner or reference), and license.
+
+| **Field**         | **Description**                                                                                                                                                                                                                                                                                       |
+|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `title`           | The unique title of the text retrieved from its original corpus (`NA` if there are no titles such as CEFR-assessed sentences or paragraphs).                                                                                                                                                         |
+| `lang`            | The source language of the text in ISO 638-1 format (e.g., `en` for English).                                                                                                                                                                                                                         |
+| `source_name`     | The source dataset name where the text is collected as indicated from their source dataset, paper, and/or documentation (e.g., `cambridge-exams` from Xia et al., 2016).                                                                                                                             |
+| `format`          | The format of the text in terms of level of granularity as indicated from their source dataset, paper, and/or documentation. The recognized formats are the following: [`document-level`, `paragraph-level`, `discourse-level`, `sentence-level`].                                                   |
+| `category`        | The classification of the text in terms of who created the material. The recognized categories are `reference` for texts created by experts, teachers, and language learning professionals and `learner` for texts written by language learners and students.                                         |
+| `cefr_level`      | The CEFR level associated with the text. The six recognized CEFR levels are the following: [`A1`, `A2`, `B1`, `B2`, `C1`, `C2`]. A small fraction (<1%) of text in UniversalCEFR contains unlabelled text, texts with plus signs (e.g., `A1+`), and texts with no level indicator (e.g., `A`, `B`). |
+| `license`         | The licensing information associated with the text (e.g., `CC-BY-NC-SA` or `Unknown` if not stated).                                                                                                                                                                                                                         |
+| `text`            | The actual content of the text itself.