Merge branch 'master' of https://github.com/D4M13N-D3V/meilisearch.NET

README.md

@@ -9,51 +9,55 @@ MeiliSearch .NET Integration is a NuGet package that seamlessly embeds MeiliSear
 
 ## Features
 
-- **Embedded MeiliSearch**: Integrate MeiliSearch directly into your application.
+- [x] **Embedded MeiliSearch**: Integrate MeiliSearch directly into your application.
-- **Background Process Management**: Automatically handles the lifecycle of the MeiliSearch process.
+- [x] **Background Process Management**: Automatically handles the lifecycle of the MeiliSearch process.
-- **Health Monitoring**: Regular checks on the health of the MeiliSearch instance.
+- [x] **Health Monitoring**: Regular checks on the health of the MeiliSearch instance.
-- **API Key Management**: An API key is automatically regenerated every time the MeiliSearch service starts unless one is specified in the configuration.
+- [x] **API Key Management**: An API key is automatically regenerated every time the MeiliSearch service starts unless one is specified in the configuration.
-- **Resource Monitoring**: Monitor the resources being used including storage by your MeiliSearch.
+- [ ] **Resource Monitoring**: Monitor the resources being used including storage by your MeiliSearch.
-- **Future Index Management**: Upcoming feature to automatically compress and decompress indexes for optimized local storage.
+- [ ] **Future Index Management**: Upcoming feature to automatically compress and decompress indexes for optimized local storage.
+
+Here’s a revised section for your README that includes details about installing your package from your GitHub Package repository:
 
 ## Installation
 
-To add the MeiliSearch .NET Integration package to your project, use the following command in the Package Manager Console:
+To add the MeiliSearch .NET Integration package to your project, you can install it directly from the GitHub Package repository. Follow the steps below based on your preferred method:
+
+### Package Manager Console
+
+Open the Package Manager Console in Visual Studio and run the following command:
 
 ```bash
-Install-Package YourPackageName
+Install-Package D4M13N-D3V/meilisearch.NET
-```
 
-Or, if you're using the .NET CLI:
+
+### .NET CLI
+
+If you're using the .NET CLI, run the following command in your terminal:
 
 ```bash
-dotnet add package YourPackageName
+dotnet add package D4M13N-D3V/meilisearch.NET
 ```
 
-## Configuration
+### Configure NuGet
 
-To configure the MeiliSearch service, add the following section to your `appsettings.json` file:
+To install the package, ensure your project is configured to use GitHub Packages as a NuGet source. You can do this by adding the following to your `nuget.config` file:
 
-```json
+```xml
-{
+<configuration>
-  ...
+  <packageSources>
-  "Meili": {
+    <add key="GitHub" value="https://nuget.pkg.github.com/D4M13N-D3V/index.json" />
-    "Port": 7700,
+  </packageSources>
-    "UiEnabled": true,
+  <packageSourceCredentials>
-    "CustomApiKey": false,
+    <GitHub>
-    "ApiKey": "YourOptionalApiKey" // Specify this if you want a fixed API key
+      <add key="Username" value="YOUR_GITHUB_USERNAME" />
-  },
+      <add key="ClearTextPassword" value="YOUR_GITHUB_TOKEN" />
-  ...
+    </GitHub>
-  "Logging": {
+  </packageSourceCredentials>
-    "LogLevel": {
+</configuration>
-      "Default": "Trace",
-      "Microsoft.AspNetCore": "Trace"
-    }
-  },
-  "AllowedHosts": "*"
-}
 ```
 
+Make sure to replace `YOUR_GITHUB_USERNAME` with your GitHub username and `YOUR_GITHUB_TOKEN` with a personal access token that has read access to packages.
+
 ### AppSettings Options
 
 - **Port**: The port on which MeiliSearch will run (default is `7700`).
@@ -124,7 +128,6 @@ MeiliSearchStatus status = service.Status;
 ```
 
 > **Note**: Please note that you should handle exceptions appropriately when using these methods, as they may throw exceptions if the process fails to start or stop.
-```
 
 
 ## License