diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..f1de07b --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,15 @@ +# These are supported funding model platforms + +github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] +patreon: # Replace with a single Patreon username +open_collective: # Replace with a single Open Collective username +ko_fi: # Replace with a single Ko-fi username +tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: # Replace with a single Liberapay username +issuehunt: # Replace with a single IssueHunt username +lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry +polar: # Replace with a single Polar username +buy_me_a_coffee: # Replace with a single Buy Me a Coffee username +thanks_dev: # Replace with a single thanks.dev username +custom: https://www.paypal.com/ncp/payment/MT7E7R6NUD7ZY # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/README.md b/README.md index 3845bf6..3ec467a 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,14 @@ ![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/build5nines/sharpvector) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) -![Framework: .NET 8+](https://img.shields.io/badge/framework-.NET%208%2B-blue) -![Semantic Search: Enabled](https://img.shields.io/badge/semantic%20search-enabled-purple) -![Gen AI: Ready](https://img.shields.io/badge/Gen%20AI-ready-purple) +![Framework: .NET 8+](https://img.shields.io/badge/Framework-.NET%208%2B-blue) +![Semantic Search: Enabled](https://img.shields.io/badge/Semantic%20Search-Enabled-purple) +![Vector Text Search: Enabled](https://img.shields.io/badge/Vector%20Text%20Search-Enabled-purple) +![Generative AI: Ready](https://img.shields.io/badge/Generative%20AI-Ready-purple) + +![Local Embeddings: Supported](https://img.shields.io/badge/Local%20Embeddings-Supported-ff1493) +![OpenAI Embeddings: Supported](https://img.shields.io/badge/OpenAI%20Embeddings-Supported-ff1493) +![Ollama Embeddings: Supported](https://img.shields.io/badge/Ollama%20Embeddings-Supported-ff1493) Vector databases are used with Semantic Search and [Generative AI](https://build5nines.com/what-is-generative-ai/?utm_source=github&utm_medium=sharpvector) solutions augmenting the LLM (Large Language Model) with the ability to load additional context data with the AI prompt using the [RAG (Retrieval-Augmented Generation)](https://build5nines.com/what-is-retrieval-augmented-generation-rag/?utm_source=github&utm_medium=sharpvector) design pattern. @@ -22,6 +27,10 @@ Build5Nines SharpVector is the lightweight, local, in-memory Text Vector Databas ### [Documentation](https://sharpvector.build5nines.com) | [Get Started](https://sharpvector.build5nines.com/get-started/) | [Samples](https://sharpvector.build5nines.com/samples/) +![Build5Nines.SharpVector Overview](/docs/docs/images/featured-build5nines-sharpvector-overview.png) + +--- + ## Nuget Package The `Build5Nines.SharpVector` library is available as a Nuget Package to easily include into your .NET projects: diff --git a/docs/docs/images/build5nines-sharpvector-key-features.png b/docs/docs/images/build5nines-sharpvector-key-features.png new file mode 100644 index 0000000..222edd1 Binary files /dev/null and b/docs/docs/images/build5nines-sharpvector-key-features.png differ diff --git a/docs/docs/images/featured-build5nines-sharpvector-overview.png b/docs/docs/images/featured-build5nines-sharpvector-overview.png new file mode 100644 index 0000000..a553cde Binary files /dev/null and b/docs/docs/images/featured-build5nines-sharpvector-overview.png differ diff --git a/docs/docs/index.md b/docs/docs/index.md index 35360eb..00da0e9 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -10,9 +10,14 @@ description: The lightweight, in-memory, semantic search, text vector database f ![Libraries.io dependency status for GitHub repo](https://img.shields.io/librariesio/github/build5nines/sharpvector) [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) -![Framework: .NET 8+](https://img.shields.io/badge/framework-.NET%208%2B-blue) -![Semantic Search: Enabled](https://img.shields.io/badge/semantic%20search-enabled-purple) -![Gen AI: Ready](https://img.shields.io/badge/Gen%20AI-ready-purple) +![Framework: .NET 8+](https://img.shields.io/badge/Framework-.NET%208%2B-blue) +![Semantic Search: Enabled](https://img.shields.io/badge/Semantic%20Search-Enabled-purple) +![Vector Text Search: Enabled](https://img.shields.io/badge/Vector%20Test%20Search-Enabled-purple) +![Generative AI: Ready](https://img.shields.io/badge/Generative%20AI-Ready-purple) + +![Local Embeddings: Supported](https://img.shields.io/badge/Local%20Embeddings-Supported-ff1493) +![OpenAI Embeddings: Supported](https://img.shields.io/badge/OpenAI%20Embeddings-Supported-ff1493) +![Ollama Embeddings: Supported](https://img.shields.io/badge/Ollama%20Embeddings-Supported-ff1493)