Update README

README.md

@@ -1 +1,31 @@
-# SemDH2024-GreekNewTestamentNames
+# SemDH2024-GreekNewTestamentNames
+
+This repo contains the notebooks used for sourcing data for `A Corpus of Biblical Names in the Greek New Testament to Study the Additions, Omissions, and Variations across Different Manuscripts`, which was submitted to [SemDH 2024: First International Workshop of Semantic Digital Humanities](https://semdh.github.io).
+
+## Install and Use
+
+The recommended Python version for using this repo is `3.9.19`. Dockerimages with Python preinstalled can be found on [Dockerhub](https://hub.docker.com/_/python).
+
+In your Python environment run `pip install -r requirements.txt` from the projects root directory to install [Jupyter](https://jupyter.org). This will enable you to run the notebooks.
+
+The notebooks will automatically download and install the required packages and modules at runtime in their respective kernel.
+
+## Updates and Refinements
+
+There will be/have been updates on this repo. Please have a look the release tags for previous versions.
+
+<!--
+## How to Cite
+
+If you use this code or data in your research, please cite:
+
+```bibtex
+@Article{Werner2024,
+  author       = {Christoph Werner and Zacharias Shoukry and Soham Al-Suadi and Frank Krüger},
+  title        = {A Corpus of Biblical Names in the Greek New Testament to Study the Additions, Omissions, and Variations across Different Manuscripts},
+  journal      = {tba},
+  year         = {2024},
+  doi          = {tba},
+}
+```
+-->