From 48b49069d7c0e2fbe34b39f546503cf3982228ac Mon Sep 17 00:00:00 2001
From: Keming <kemingyang@tensorchord.ai>
Date: Wed, 24 Jan 2024 22:58:49 +0800
Subject: [PATCH] chore: update readme (#4)

Signed-off-by: Keming <kemingyang@tensorchord.ai>
---
 README.md | 32 ++++++++++++++++++++++++++++++--
 1 file changed, 30 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 40b3d63..5b61e56 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
 Supported databases/extensions:
 
 - [x] [`pgvecto.rs`](https://github.com/tensorchord/pgvecto.rs)
-- [ ] [`pgvector`](https://github.com/pgvector/pgvector)
+- [x] [`pgvector`](https://github.com/pgvector/pgvector)
 - [ ] [`qdrant`](https://github.com/qdrant/qdrant/)
 
 Supported datasets:
@@ -11,7 +11,6 @@ Supported datasets:
 - [x] random generated
 - [x] GIST 960
 
-
 ## Installation
 
 ```bash
@@ -20,6 +19,16 @@ pip install vector_bench
 
 ## Run
 
+### Server
+
+Run the docker compose file under [`server`](server/) folder.
+
+```base
+cd server/pgvecto.rs && docker compose up -d
+```
+
+### Client
+
 ```bash
 # help
 vector_bench --help
@@ -30,3 +39,22 @@ vector_bench --query --url postgresql://postgres:password@localhost:5432/postgre
 # insert and query the data
 vector_bench --insert --query --url postgresql://postgres:password@localhost:5432/postgres -s gist_960_l2
 ```
+
+## How to contribute
+
+```bash
+# install all the necessary dependencies:
+make dev
+# format code
+make format
+# lint
+make lint
+```
+
+### Add more datasets
+
+- Add new `DatasetConfig` to `vector_bench/dataset/source.py`
+
+### Add more clients
+
+- Inherit and implement the `BaseClient` class in `vector_bench/client/base.py`