From 7ba3b9bd651caad338017d167a63cf5e05aae527 Mon Sep 17 00:00:00 2001
From: Niklas Muennighoff <n.muennighoff@gmail.com>
Date: Tue, 6 Aug 2024 15:06:08 -0700
Subject: [PATCH] Add instructions

---
 README.md | 15 +++++++++++----
 1 file changed, 11 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index c916ea98..67918726 100644
--- a/README.md
+++ b/README.md
@@ -27,8 +27,15 @@ This repository contains the code for pushing and updating the MTEB leaderboard
 
 To setup the repository:
 
-```         
-git clone {repo_url}
-# potentially create virtual environment using python 3.9
+```bash
+git clone https://github.com/embeddings-benchmark/leaderboard.git
+cd leaderboard
+# install requirements
 pip install -r requirements.txt
-```
\ No newline at end of file
+# fetch new results
+# python refresh.py
+# if you'd like to add results to previously cached models, you may have to remove these models in `EXTERNAL_MODEL_RESULTS.json`
+# you can also directly delete `EXTERNAL_MODEL_RESULTS.json` and it will recreate it (but be much slower)
+# run the leaderboard
+python app.py
+```