* chore: update project description in pyproject.toml

* docs: update project description in README.md and docs/index.md
qdrant · Aug 24, 2023 · 88b595f · 88b595f
1 parent 1809e8c
commit 88b595f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # ⚡️ What is FastEmbed?
 
-FastEmbed is an easy to use -- lightweight, fast, Python library built for retrieval augmented generation. The default embedding supports "query" and "passage" prefixes for the input text.
+FastEmbed is an easy to use -- lightweight, fast, Python library built for retrieval embedding generation. 
+
+The default embedding supports "query" and "passage" prefixes for the input text. The default model is Flag Embedding, which is top of the [MTEB](https://huggingface.co/spaces/mteb/leaderboard) leaderboard.
 
 1. Light
     - Quantized model weights

diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,8 @@
 # ⚡️ What is FastEmbed?
 
-FastEmbed is an easy to use -- lightweight, fast, Python library built for retrieval augmented generation. The default embedding supports "query" and "passage" prefixes for the input text.
+FastEmbed is an easy to use -- lightweight, fast, Python library built for retrieval embedding generation. The default embedding supports "query" and "passage" prefixes for the input text.
+
+The default embedding supports "query" and "passage" prefixes for the input text. The default model is Flag Embedding, which is top of the [MTEB](https://huggingface.co/spaces/mteb/leaderboard) leaderboard.
 
 ## 🚀 Installation
 

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "fastembed"
 version = "0.0.4"
-description = "Fast, State of the Art Quantized Embedding Models"
+description = "Fast, light, accurate library built for retrieval embedding generation"
 authors = ["NirantK <[email protected]>"]
 license = "Apache License"
 readme = "README.md"