Update README.md

README.md

@@ -1,3 +1,226 @@
 ---
 license: cc-by-nc-sa-4.0
+language:
+- kwn
+- nno
+- mlg
+- miu
+- mhi
+- yua
+- dga
+- pol
+- sck
+- nuj
+- ben
+- san
+- luo
+- guz
+- hus
+- adh
+- lwg
+- lue
+- nhw
+- mer
+- lug
+- xsm
+- ell
+- rus
+- afr
+- ewe
+- yue
+- mnw
+- laj
+- myx
+- fra
+- adx
+- teo
+- cce
+- kln
+- hat
+- zne
+- srp
+- mmc
+- mal
+- fat
+- nyu
+- ndo
+- ven
+- hch
+- ssw
+- kqn
+- mhw
+- koo
+- prs
+- nso
+- yor
+- zho
+- naq
+- nle
+- mqu
+- lun
+- tuv
+- ocu
+- sme
+- kdj
+- alz
+- lit
+- spa
+- mfe
+- maz
+- tum
+- nhe
+- hun
+- dje
+- ori
+- swa
+- ron
+- her
+- urd
+- ttj
+- ktz
+- tur
+- kam
+- sag
+- kru
+- kok
+- toi
+- jpn
+- orm
+- rki
+- tsn
+- nep
+- tha
+- zul
+- ctu
+- khg
+- dag
+- pcm
+- keo
+- lko
+- amh
+- saq
+- jam
+- ara
+- kik
+- toh
+- kan
+- lgg
+- tam
+- aeb
+- ckb
+- deu
+- guj
+- ukr
+- tir
+- tet
+- mar
+- bxk
+- gur
+- vie
+- old
+- nch
+- kpz
+- xho
+- crk
+- ita
+- kmr
+- nyn
+- por
+- kri
+- gaa
+- hin
+- asm
+- mas
+- xog
+- khm
+- csw
+- nor
+- tgl
+- kin
+- luc
+- ful
+- sqi
+- kua
+- cat
+- tsc
+- pus
+- nld
+- kor
+- sot
+- mya
+- lat
+- bod
+- eng
+- nob
+- nzi
+- twi
+- hau
+- dan
+- kau
+- pan
+- swe
+- fas
+- som
+- tso
+- loz
+- anu
+- tel
+- ada
+- nbl
+- lsm
+- ach
+- bem
+- pmq
+- mat
+- gjn
+- nya
+- epo
+
+pretty_name: GlotStoryBook Corpus
 ---
+
+# GlotStoryBook Corpus
+
+Story Books for 180 ISO-639-3 script pairs (174 unique ISO-639-3 codes).
+
+## Usage (HF Loader)
+```python
+from datasets import load_dataset
+dataset = load_dataset('cis-lmu/GlotStoryBook')
+print(dataset['train'][0]) # First row data
+```
+
+## Download
+If you are not a fan of the HF dataloader or are just interested in a specific language, download it directly:
+Replace `twi_Latn` with your specific language.
+
+```python
+! wget https://huggingface.co/datasets/cis-lmu/GlotStoryBook/resolve/main/GlotStoryBook.csv
+```
+
+
+## License and Copyright
+All the files are collected from the repository located at https://github.com/global-asp/. The source repository for each text and file is stored in the dataset.
+Each file in the dataset is associated with one license from the CC family. The licenses include 'CC BY', 'CC BY-NC', 'CC BY-NC-SA', 'CC-BY', 'CC-BY-NC', and 'Public Domain'.
+
+
+## Github
+We additionally provide a GitHub version that openly shares the source code for processing this dataset:
+https://github.com/cisnlp/GlotStoryBook
+
+
+## Citation
+If you use any part of this code and data in your research, please cite it using the following BibTeX entry.
+This work is part of the [GlotLID](https://github.com/cisnlp/GlotLID) project.
+
+```
+@inproceedings{
+  kargaran2023glotlid,
+  title={{GlotLID}: Language Identification for Low-Resource Languages},
+  author={Kargaran, Amir Hossein and Imani, Ayyoob and Yvon, Fran{\c{c}}ois and Sch{\"u}tze, Hinrich},
+  booktitle={The 2023 Conference on Empirical Methods in Natural Language Processing},
+  year={2023},
+  url={https://openreview.net/forum?id=dl4e3EBz5j}
+}
+
+```