Update README.md

README.md

@@ -1,13 +1,18 @@
+---
+license: cc-by-4.0
+---
 # UN-RES: A Collection of Resolutions of United Nations for Religion and Spirituality in Health and Education
 
 Dataset proposed in paper *SpiritRAG: A Q&A ystem for Religion and Spirituality in the United Nations Archive*.
 
----
-## ⬇️ Download 
+## 🔽 Full Dataset Download (~10 GB)
 
-📚 [Zenodo](https://zenodo.org/records/15746545)
+📚 You can download the full dataset at [Zenodo](https://zenodo.org/records/15746545).
 
-©️ UN-RES is under CC BY 4.0 license. 
+©️ UN-RES is under **CC BY 4.0 license**. If you plan to use this dataset for commercial purposes, please contact the dataset creator.
+
+## 📦 Sample Subset on Hugging Face
+This repository includes a representative sample (~10 examples for *health* and *education* each in the `sample` folder) for quick inspection.
 
 ## 🗂️ Dataset Structure
 
@@ -15,31 +20,59 @@ Dataset proposed in paper *SpiritRAG: A Q&A ystem for Religion and Spirituality
 
 - Switch to the folder: `cd ./UN-RES`
 
-Each data instance is stored in a folder with a unique ID. Inside each folder:
+- Each data instance is stored in a folder with a document ID. See below the datastructure:
 
+<pre>
 UN-RES/
 ├── health/
 │   ├── crawled_data/
-        ├── A-RES-76-180/
-            ├── A-RES-76-180-ar.pdf
-            ├── A-RES-76-180-de.pdf
-            ├── A-RES-76-180-en.pdf
-            ├── A-RES-76-180-es.pdf
-            ├── A-RES-76-180-fr.pdf
-            ├── A-RES-76-180-ru.pdf
-            ├── A-RES-76-180-zh.pdf
-            ├── metadata.jsonl
-        ...
+│   │   ├── A-RES-70-1/
+│   │   │   ├── A-RES-70-1-ar.pdf
+│   │   │   ├── A-RES-70-1-de.pdf
+│   │   │   ├── A-RES-70-1-en.pdf
+│   │   │   ├── A-RES-70-1-es.pdf
+│   │   │   ├── A-RES-70-1-fr.pdf
+│   │   │   ├── A-RES-70-1-ru.pdf
+│   │   │   ├── A-RES-70-1-zh.pdf
+│   │   │   └── metadata.jsonl
+│   │   ...
 │   └── parsed_data/
-        ├── A-RES-76-180/
-            ├── A-RES-76-180-de-parsed.json
-            ├── A-RES-76-180-en-parsed.json
-            ├── A-RES-76-180-es-parsed.json
-            ├── A-RES-76-180-fr-parsed.json
-├── education/
-│   ├── crawled_data/
-    ...
-│   ├── parsed_data/
-    ...
+│       ├── A-RES-70-1/
+│       │   ├── A-RES-70-1-de-parsed.json
+│       │   ├── A-RES-70-1-en-parsed.json
+│       │   ├── A-RES-70-1-es-parsed.json
+│       │   └── A-RES-70-1-fr-parsed.json
+└── education/
+    ├── crawled_data/
+    │   ...
+    └── parsed_data/
+        ...
+</pre>
+
+- The `metadata.jsonl` stores the metadata information of the resolution document
+
+```json
+{
+  "symbol": "A/RES/70/1",
+  "title": "Transforming our world : the 2030 Agenda for Sustainable Development : resolution / adopted by the General Assembly",
+  "session_year": "70",
+  "agenda_items": "15 116",
+  "distribution": "GEN",
+  "area": "UNDOC",
+  "subjects": "SUSTAINABLE DEVELOPMENT, DEVELOPMENT STRATEGIES, PEACE, PARTNERSHIP, POVERTY MITIGATION, HUNGER, FOOD SECURITY, HEALTH, EDUCATION, GENDER EQUALITY, WATER MANAGEMENT, SUSTAINABLE ENERGY, EMPLOYMENT, INDUSTRIALIZATION, INCOME DISTRIBUTION, HUMAN SETTLEMENTS, SUSTAINABLE CONSUMPTION, CLIMATE CHANGE, MARINE RESOURCES, TERRESTRIAL ECOSYSTEMS, JUSTICE",
+  "publication_date": "21/10/2015",
+  "languages": ["ar", "zh", "en", "fr", "ru", "es", "de"]
+}
+```
 
+## Citation
+If you use this dataset in your work, please cite
 
+```
+@article{gao2025spiritrag,
+  author={Gao, Yingqiang and Winiger, Fabian and Montjourides, Patrick and Shaitarova, Anastassia and Gu, Nianlong and Peng-Keller, Simon and Schneider, Gerold},
+  title={{SpiritRAG: A Q&A System for Religion and Spirituality in the United Nations Archive}},
+  year={2025},
+  journal={arXiv preprint arXiv:XXX}
+}
+```