Skip to content

Commit cc20b9d

Browse files
authored
Samuel100/cs readme patch (#170)
* update readme with installer instructions * update * fix line breaks * fix links * update c# readme * update readme to winget installer
1 parent 3cccc5c commit cc20b9d

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

sdk/cs/README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
# Foundry Local C# SDK (under active development)
2-
3-
> This SDK is under active development and may not be fully functional.
1+
# Foundry Local C# SDK
42

53
## Installation
64

5+
To use the Foundry Local C# SDK, you need to install the NuGet package:
6+
7+
```bash
8+
dotnet add package Microsoft.AI.Foundry.Local
9+
```
10+
11+
### Building from source
712
To build the SDK, run the following command in your terminal:
813

914
```bash
@@ -28,10 +33,14 @@ Then, install the package using the following command:
2833
dotnet add package FoundryLocal --source foundry-local
2934
```
3035

31-
An official NuGet package will be available soon.
32-
3336
## Usage
3437

38+
> [!NOTE]
39+
> For this example, you'll need the OpenAI Nuget package installed as well:
40+
> ```bash
41+
> dotnet add package OpenAI
42+
> ```
43+
3544
```csharp
3645
using Microsoft.AI.Foundry.Local;
3746
using OpenAI;
@@ -41,7 +50,7 @@ using System.Diagnostics.Metrics;
4150
4251
var alias = "phi-3.5-mini";
4352
44-
var manager = await FoundryManager.StartModelAsync(aliasOrModelId: alias);
53+
var manager = await FoundryLocalManager.StartModelAsync(aliasOrModelId: alias);
4554
4655
var model = await manager.GetModelInfoAsync(aliasOrModelId: alias);
4756
ApiKeyCredential key = new ApiKeyCredential(manager.ApiKey);

0 commit comments

Comments
 (0)