Update README.md

README.md

@@ -1,7 +1,7 @@
 ---
 license: cc0-1.0
 configs:
-- config_name: default
+- config_name: data
   data_files:
   - split: XL_all
     path: data/XL_all-*
@@ -89,6 +89,37 @@ dataset_info:
     num_examples: 2934
   download_size: 1448868
   dataset_size: 14177087
-  pretty_name: PRIDE Crosslinking Archive
 pretty_name: PRIDE Crosslinking Archive
----
+---
+
+# PRIDE Crosslinking Archive
+
+<!-- Provide a quick summary of the dataset. -->
+
+This dataset aggregates publicly available crosslinking mass spectrometry (XL-MS) datasets from the PRIDE repository.
+Each dataset is curated and categorized by crosslinking reagent a link type (inter-chain vs intra-chain). For intra-chain links where the protein can be mapped to a
+UniProt ID, each link is mapped onto the corresponding AlphaFold Database (AFDB) structure, and the Cα-Cα distance for the linked residue pair is reported.
+
+The result is a standardized resource for analyzing XL-MS constraints across reagents and for benchmarking/evaluating integrative modeling pipelines.
+
+## Quickstart Usage
+
+### Install HuggingFace Datasets package
+
+Each subset can be loaded into python using the Huggingface [datasets](https://huggingface.co/docs/datasets/index) library.
+First, from the command line install the `datasets` library
+
+    $ pip install datasets
+
+Optionally set the cache directory, e.g.
+
+    $ HF_HOME=${HOME}/.cache/huggingface/
+    $ export HF_HOME
+
+then, from within python load the datasets library
+
+    >>> import datasets
+
+### Load model datasets
+
+To load one of the `PRIDE_Crosslinking_Archive` datasets, use `datasets.load_dataset(...)`