Make package compatible with Transformers.js models

README.md

@@ -1,6 +1,8 @@
 # Vector Storage
 
-Vector Storage is a lightweight and efficient vector database that stores document vectors in the browser's IndexedDB. This package allows you to perform semantic similarity searches on text documents using vector embeddings. Semantic search refers to the ability to understand the meaning and context of text documents and queries, enabling more accurate and relevant search results. Vector Storage leverages OpenAI embeddings to convert text documents into vectors and provides an interface for searching similar documents based on cosine similarity.
+Forked from [vector-storage](https://github.com/nitaiaharoni1/vector-storage) with patches to allow for Transformer.js embeddings.
+
+Vector Storage is a lightweight and efficient vector database that stores document vectors in the browser's IndexedDB. This package allows you to perform semantic similarity searches on text documents using vector embeddings. Semantic search refers to the ability to understand the meaning and context of text documents and queries, enabling more accurate and relevant search results. Vector Storage leverages OpenAI or Transformer.js embeddings (see compatible models [here](https://huggingface.co/models?library=transformers.js)) to convert text documents into vectors and provides an interface for searching similar documents based on cosine similarity.
 
 ## Features
 
@@ -71,7 +73,7 @@ interface IVSOptions {
   openAIApiKey: string; // The OpenAI API key used for generating embeddings.
   maxSizeInMB?: number; // The maximum size of the storage in megabytes. Defaults to 2GB
   debounceTime?: number; // The debounce time in milliseconds for saving to IndexedDB. Defaults to 0.
-  openaiModel?: string; // The OpenAI model used for generating embeddings. Defaults to 'text-embedding-ada-002'.
+  openaiModel?: string; // The OpenAI model used for generating embeddings.
 }
 ```
 
@@ -131,4 +133,4 @@ Please ensure that your code follows the project's coding style and that all tes
 
 This project is licensed under the MIT License. See the LICENSE file for the full license text.
 
-Copyright (c) Nitai Aharoni. All rights reserved.
+Copyright (c) Nitai Aharoni. All rights reserved.