Added readmes for dataprep and vectorstores (opea-project#83)

* added readmes for dataprep and vectorstores. --------- Signed-off-by: Ye, Xinyu <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Signed-off-by: V, Ganesan <[email protected]>
ganesanintel · Jun 3, 2024 · 989f477 · 989f477
1 parent ed1a5aa
commit 989f477
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 1 deletion.
diff --git a/comps/dataprep/README.md b/comps/dataprep/README.md
@@ -0,0 +1,11 @@
+# Dataprep Microservice
+
+The Dataprep Microservice aims to preprocess the data from various sources, either structured or unstructured data, to text data, and convert the text data to embedding vectors then store them in the database.
+
+# Dataprep Microservice with Redis
+
+For details, please refer to this [readme](redis/README.md)
+
+# Dataprep Microservice with Qdrant
+
+For details, please refer to this [readme](qdrant/README.md)
diff --git a/comps/dataprep/qdrant/README.md b/comps/dataprep/qdrant/README.md
@@ -1,3 +1,5 @@
+# Dataprep Microservice with Qdrant
+
 # 🚀Start Microservice with Python
 
 ## Install Requirements

diff --git a/comps/dataprep/redis/README.md b/comps/dataprep/redis/README.md
@@ -1,4 +1,4 @@
-# Dataprep Microservice
+# Dataprep Microservice with Redis
 
 # 🚀Start Microservice with Python
 

diff --git a/comps/vectorstores/README.md b/comps/vectorstores/README.md
@@ -0,0 +1,11 @@
+# Vectorstores Microservice
+
+The Vectorstores Microservice provides convenient way to start various vector database servers.
+
+# Vectorstores Microservice with Redis
+
+For details, please refer to this [readme](langchain/redis/README.md)
+
+# Vectorstores Microservice with Qdrant
+
+For details, please refer to this [readme](langchain/qdrant/README.md)