Update readme

README.md

@@ -30,4 +30,38 @@ tags:
 - convAI
 ---
 
-# WebLINX Chat Dataset
+
+# WebLINX: Real-World Website Navigation with Multi-Turn Dialogue
+
+*Xing Han Lù, Zdeněk Kasner, Siva Reddy*
+
+[Link to the website](https://mcgill-nlp.github.io/weblinx)
+
+
+## Quickstart
+
+To get started, simply install `datasets` with `pip install datasets` and load the chat data splits:
+
+```python
+from datasets import load_dataset
+
+# Load the training, validation and test (IID) splits
+train = load_dataset("McGill-NLP/weblinx", "train")
+valid = load_dataset("McGill-NLP/weblinx", "valid")
+test = load_dataset("McGill-NLP/weblinx", "test")
+
+# Load one of the 4 out-of-domain splits (test_web, test_vis, test_geo, test_cat)
+test_web = load_dataset("McGill-NLP/weblinx", "test_web")
+```
+
+## Raw Data
+
+To use the raw data, you will need to use the `huggingface_hub`:
+
+```python
+from huggingface_hub import snapshot_download
+
+snapshot_download(repo_id="McGill-NLP/WebLINX-full", repo_type="dataset", local_dir="./data/weblinx")
+```
+
+For more information on how to use this data using our [official library](https://github.com/McGill-NLP/WebLINX), please refer to the [WebLINX documentation](https://mcgill-nlp.github.io/WebLINX/docs).