Skip to content

Commit 709fed1

Browse files
authored
Merge pull request #13 from managedcode/codex/readme-nuget-badges
Document latest NuGet packages and live badges
2 parents 6cd72dd + e58e357 commit 709fed1

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
**Give your .NET agents a workspace they can explore, understand, and edit.**
44

5-
[![NuGet](https://img.shields.io/nuget/v/ManagedCode.FileContext.svg)](https://www.nuget.org/packages/ManagedCode.FileContext)
5+
[![NuGet](https://img.shields.io/nuget/v/ManagedCode.FileContext.svg?style=flat-square&logo=nuget)](https://www.nuget.org/packages/ManagedCode.FileContext)
66
[![Build](https://github.com/managedcode/FileContext/actions/workflows/ci.yml/badge.svg)](https://github.com/managedcode/FileContext/actions/workflows/ci.yml)
77
[![CodeQL](https://github.com/managedcode/FileContext/actions/workflows/codeql.yml/badge.svg)](https://github.com/managedcode/FileContext/actions/workflows/codeql.yml)
88
[![.NET 10](https://img.shields.io/badge/.NET-10-512BD4)](https://dotnet.microsoft.com/)
99
[![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/managedcode/FileContext/blob/main/LICENSE)
10+
[![Release](https://github.com/managedcode/FileContext/actions/workflows/release.yml/badge.svg?branch=main)](https://github.com/managedcode/FileContext/actions/workflows/release.yml)
11+
[![Downloads](https://img.shields.io/nuget/dt/ManagedCode.FileContext.svg?style=flat-square&logo=nuget)](https://www.nuget.org/packages/ManagedCode.FileContext)
1012

1113
FileContext connects [ManagedCode.Storage](https://github.com/managedcode/Storage) to **Microsoft Agent Framework**. Agents can discover files, search their contents, read relevant line ranges, and work across Markdown documents as a knowledge graph. Enable write tools when the agent needs to create or edit files.
1214

@@ -43,17 +45,19 @@ flowchart LR
4345

4446
## Install
4547

48+
Install the latest stable release from [NuGet](https://www.nuget.org/packages/ManagedCode.FileContext):
49+
4650
Requires **.NET 10**. Add FileContext and the storage provider your application uses:
4751

4852
```bash
49-
dotnet add package ManagedCode.FileContext --version 1.0.9
50-
dotnet add package ManagedCode.Storage.FileSystem --version 10.0.7
53+
dotnet add package ManagedCode.FileContext
54+
dotnet add package ManagedCode.Storage.FileSystem
5155
```
5256

5357
The examples below also use the DI service-provider implementation:
5458

5559
```bash
56-
dotnet add package Microsoft.Extensions.DependencyInjection --version 10.0.11
60+
dotnet add package Microsoft.Extensions.DependencyInjection
5761
```
5862

5963
## Quick start
@@ -384,13 +388,13 @@ dotnet pack src/ManagedCode.FileContext/ManagedCode.FileContext.csproj --configu
384388

385389
## Releases and license
386390

387-
Version `1.0.9` is defined centrally in `Directory.Build.props`. Every push to `main` runs the Release workflow: restore, format, build, test with coverage, and pack. For a new package version, it publishes the validated NuGet artifact and creates the matching tag and GitHub release automatically. Already released versions are skipped. To release an update, bump the version, commit, and push; no manual tag is required.
391+
The package version is defined centrally in `Directory.Build.props`. Every push to `main` runs the Release workflow: restore, format, build, test with coverage, and pack. For a new package version, it publishes the validated NuGet artifact and creates the matching tag and GitHub release automatically. Already released versions are skipped. To release an update, bump the version, commit, and push; no manual tag is required.
388392

389393
[MIT licensed](https://github.com/managedcode/FileContext/blob/main/LICENSE) · Built by [ManagedCode](https://github.com/managedcode)
390394

391395
## Create text, CSV, Excel and PDF
392396

393-
Version 1.0.1 adds native document tools to the same scoped FileContext used for reads, listing and metadata. Set `EnableWriteTools = true` on the shared options passed to the store, service and provider. Creation tools retain human approval by default. Each result has a unique `outputs/<id>/<name>` path, content type and byte length; creation never overwrites another file. Hosts own download URLs and user authorization.
397+
FileContext provides native document tools to the same scoped FileContext used for reads, listing and metadata. Set `EnableWriteTools = true` on the shared options passed to the store, service and provider. Creation tools retain human approval by default. Each result has a unique `outputs/<id>/<name>` path, content type and byte length; creation never overwrites another file. Hosts own download URLs and user authorization.
394398

395399
```csharp
396400
var options = new FileContextOptions

0 commit comments

Comments
 (0)