Merge pull request #17 from Build5Nines/dev

Dev

Author: crpietschmann

.github/workflows/build-release.yml

@@ -31,11 +31,17 @@ jobs:
     - name: Build
       run: dotnet build --configuration Release --no-restore
 
-    - name: Publish
-      run: dotnet publish --configuration Release --output ./publish --no-build
+    # - name: Publish
+    #   run: dotnet publish --configuration Release --output ./publish --no-build
+
+    # - name: Upload artifact
+    #   uses: actions/upload-artifact@v4
+    #   with:
+    #     name: release-build
+    #     path: ./publish
 
     - name: Upload artifact
       uses: actions/upload-artifact@v4
       with:
-        name: release-build
-        path: ./publish
+        name: nuget-package
+        path: '**/*.nupkg'

README.md

@@ -50,10 +50,6 @@ dotnet add package Build5Nines.SharpVector
 
 You can view it on Nuget.org here: <https://www.nuget.org/packages/Build5Nines.SharpVector/>
 
-## Supports .NET 6 and greater
-
-For maximum compatibility, the `Build5Nines.SharpVector` library is built using no external dependencies other than what's available from .NET, and it's built to target .NET 6 and greater.
-
 ## Example Usage
 
 ### Loading and Searching Vector Database
@@ -143,6 +139,10 @@ Here's a screenshot of the test console app running:
 
 ## Change Log
 
+## v1.0.1 (2025-02-06)
+
+- Upgrade to .NET 8 or higher
+
 ### v1.0.0 (2024-05-24)
 
 - Simplify object model by combining Async and non-Async classes, `BasicMemoryVectorDatabase` now support both synchronous and asynchronous operations.

src/Build5Nines.SharpVector/docs/README.md

@@ -47,3 +47,11 @@ loader.AddDocument(document, new TextChunkingOptions<string>
     }
 });
 ```
+
+## Tutorials
+
+Here's a couple helpful tutorial links with additional documentation and examples on using `Build5Nines.SharpVector` in your own projects:
+
+- [Perform Vector Database Similarity Search in .NET Apps using Build5Nines.SharpVector](https://build5nines.com/using-build5nines-sharpvector-for-vector-similarity-search-in-net-applications/) by Chris Pietschmann
+- [Build a Generative AI + RAG App in C# with Phi-3, ONNX, and SharpVector](https://build5nines.com/build-a-generative-ai-rag-app-in-c-with-phi-3-onnx-and-sharpvector/) by Chris Pietschmann
+- [Implementing Local RAG using Phi-3 ONNX Runtime and Sidecar Pattern on Linux App Service](https://azure.github.io/AppService/2024/09/03/Phi3-vector.html) by Tulika Chaudharie (Principal Product Manager at Microsoft for Azure App Service)