Skip to content

Commit 5d5be30

Browse files
committed
docs: update README to reflect AWS SDK v4 preview availability and version strategy
1 parent 161a7b4 commit 5d5be30

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
1-
# LocalStack .NET Client ![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client) [![NuGet v1.x](https://img.shields.io/endpoint?url=https%3A%2F%2Fyvfdbfas85.execute-api.eu-central-1.amazonaws.com%2Flive%2F%3Fpackage%3Dlocalstack.client%26source%3Dnuget%26track%3D1%26includeprerelease%3Dtrue%26label%3Dnuget)](https://www.nuget.org/packages/LocalStack.Client/) [![NuGet v2.x](https://img.shields.io/endpoint?url=https%3A%2F%2Fyvfdbfas85.execute-api.eu-central-1.amazonaws.com%2Flive%2F%3Fpackage%3Dlocalstack.client%26source%3Dnuget%26track%3D2%26includeprerelease%3Dtrue%26label%3Dnuget)](https://www.nuget.org/packages/LocalStack.Client/) [![CI/CD Pipeline](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci-cd.yml) [![Security](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/github-code-scanning/codeql)
1+
# LocalStack .NET Client
22

3-
> ## ⚠️ AWS SDK v4 Transition Notice
4-
>
5-
> **Current Status**: This main branch is under active development for **AWS SDK v4 support (v2.0)**
6-
>
3+
[![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client)](https://www.nuget.org/packages/LocalStack.Client/) [![NuGet v1.x](https://img.shields.io/endpoint?url=https%3A%2F%2Fyvfdbfas85.execute-api.eu-central-1.amazonaws.com%2Flive%2F%3Fpackage%3Dlocalstack.client%26source%3Dnuget%26track%3D1%26includeprerelease%3Dtrue%26label%3Dnuget)](https://www.nuget.org/packages/LocalStack.Client/) [![NuGet v2.x](https://img.shields.io/endpoint?url=https%3A%2F%2Fyvfdbfas85.execute-api.eu-central-1.amazonaws.com%2Flive%2F%3Fpackage%3Dlocalstack.client%26source%3Dnuget%26track%3D2%26includeprerelease%3Dtrue%26label%3Dnuget)](https://www.nuget.org/packages/LocalStack.Client/) [![CI/CD Pipeline](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci-cd.yml) [![Security](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/github-code-scanning/codeql)
4+
5+
---
6+
7+
> ## 🎉 AWS SDK v4 Preview Now Available
8+
>
9+
> **v2.0.0-preview1** is now available on both NuGet and GitHub Packages with **complete AWS SDK v4 support**!
10+
>
711
> **Version Strategy**:
12+
>
813
> - **v1.x** (AWS SDK v3): Maintenance mode → Available on [sdkv3-lts branch](https://github.com/localstack-dotnet/localstack-dotnet-client/tree/sdkv3-lts) (EOL: July 31, 2026)
9-
> - **v2.x** (AWS SDK v4): Active development → Native AOT support in subsequent v2.x releases
10-
>
14+
> - **v2.x** (AWS SDK v4): **Preview Available** → Native AOT support in subsequent v2.x releases
15+
>
1116
> **Migration Timeline**: Q3 2025 for v2.0.0 GA
12-
>
17+
>
1318
> 📖 **[Read Full Roadmap & Migration Guide →](../../discussions)**
1419
1520
![LocalStack](https://github.com/localstack-dotnet/localstack-dotnet-client/blob/master/assets/localstack-dotnet.png?raw=true)
@@ -21,7 +26,7 @@ Localstack.NET is an easy-to-use .NET client for [LocalStack](https://github.com
2126
| LocalStack.NET Version | AWS SDK Version | .NET Support | Status | Branch |
2227
|------------------------|-----------------|--------------|---------|---------|
2328
| v1.x | AWS SDK v3 | .NET 8, 9, Standard 2.0, Framework 4.6.2 | Maintenance (until July 2026) | [sdkv3-lts](../../tree/sdkv3-lts) |
24-
| v2.x | AWS SDK v4 | .NET 8, 9, Standard 2.0, Framework 4.7.2 | Active Development | [master](../../tree/main) |
29+
| v2.x | AWS SDK v4 | .NET 8, 9, Standard 2.0, Framework 4.7.2 | Preview Available (v2.0.0-preview1) | [master](../../tree/main) |
2530

2631
## Package Status
2732

@@ -87,13 +92,14 @@ LocalStack.NET is available through multiple package sources to support differen
8792

8893
### 📦 Package Installation
8994

90-
#### Stable Releases (NuGet.org)
95+
#### AWS SDK v4 Preview (v2.0.0-preview1)
9196

92-
For production use and stable releases:
97+
For testing AWS SDK v4 compatibility:
9398

9499
```bash
95-
dotnet add package LocalStack.Client
96-
dotnet add package LocalStack.Client.Extensions
100+
# Install v2.0.0-preview1 with AWS SDK v4 support
101+
dotnet add package LocalStack.Client --version 2.0.0-preview1
102+
dotnet add package LocalStack.Client.Extensions --version 2.0.0-preview1
97103
```
98104

99105
#### Development Builds (GitHub Packages)

0 commit comments

Comments
 (0)