Update README.md

README.md

@@ -1,3 +1,30 @@
-# WebLINX: Real-World Website Navigation with Multi-Turn Dialogue
+# [WebLINX: Real-World Website Navigation with Multi-Turn Dialogue](https://mcgill-nlp.github.io/weblinx)
 
-*Xing Han Lu, Zdenek Kasner, Siva Reddy*
+*Xing Han Lù, Zdeněk Kasner, Siva Reddy*
+
+
+## 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")
+val = load_dataset("McGill-NLP/weblinx", "valid")
+test = load_dataset("McGill-NLP/weblinx", "test")
+
+# Load one of the 4 out-of-domain splits (web, vis, geo, cat)
+ood = load_dataset("McGill-NLP/weblinx", "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", repo_type="dataset", local_dir="./data/webtasks")
+```