Skip to content

Commit 873efbf

Browse files
committed
docs: update README for v2.0.0 release, correcting version references and installation instructions
1 parent 2b8c8b8 commit 873efbf

File tree

3 files changed

+33
-39
lines changed

3 files changed

+33
-39
lines changed

README.md

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

33
[![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client)](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/) [![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/) [![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) [![Linux Tests](https://img.shields.io/endpoint?url=https://yvfdbfas85.execute-api.eu-central-1.amazonaws.com/live/badge/tests/linux?label=Tests)](https://yvfdbfas85.execute-api.eu-central-1.amazonaws.com/live/redirect/test-results/linux)
44

5-
> **🚀 Quick Start**: `dotnet add package LocalStack.Client --version 2.0.0-preview1` (AWS SDK v4) | [Installation Guide](#-installation) | [GA Timeline](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)
5+
> **🚀 Quick Start**: `dotnet add package LocalStack.Client --version 2.0.0` (AWS SDK v4) | [Installation Guide](#-installation) | [GA Timeline](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)
66
77
---
88

99
## 🎉 What's New: AWS SDK v4 Support Available
1010

11-
**v2.0.0-preview1** is live with complete AWS SDK v4 support - easier migration than expected!
11+
**v2.0.0** is live with complete AWS SDK v4 support - easier migration than expected!
1212

13-
-**1,099 tests passing** across all frameworks
13+
-**1,168 tests passing** across all frameworks
1414
-**Minimal breaking changes** (just .NET Framework 4.6.2 → 4.7.2 and AWS SDK v3 → v4)
1515
-**Public APIs unchanged** - your code should work as-is!
1616
- 📖 **[Read Full Roadmap](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)**
@@ -143,14 +143,12 @@ LocalStack.NET is available through multiple package sources to support differen
143143

144144
### 📦 Package Installation
145145

146-
#### AWS SDK v4 Preview (v2.0.0-preview1)
147-
148-
For testing AWS SDK v4 compatibility:
146+
To install the latest version of LocalStack.NET with AWS SDK v4 support, use the following command:
149147

150148
```bash
151-
# Install v2.0.0-preview1 with AWS SDK v4 support
152-
dotnet add package LocalStack.Client --version 2.0.0-preview1
153-
dotnet add package LocalStack.Client.Extensions --version 2.0.0-preview1
149+
# Install v2.0.0 with AWS SDK v4 support
150+
dotnet add package LocalStack.Client --version 2.0.0
151+
dotnet add package LocalStack.Client.Extensions --version 2.0.0
154152
```
155153

156154
#### Development Builds (GitHub Packages)
@@ -257,13 +255,13 @@ To build the project, use the following commands based on your operating system:
257255

258256
Windows
259257

260-
```
258+
```powershell
261259
build.ps1
262260
```
263261

264262
Linux
265263

266-
```
264+
```bash
267265
./build.sh
268266
```
269267

@@ -277,13 +275,13 @@ To execute the tests, use the commands below:
277275

278276
Windows
279277

280-
```
278+
```powershell
281279
build.ps1 --target=tests
282280
```
283281

284282
Linux
285283

286-
```
284+
```bash
287285
./build.sh --target=tests
288286
```
289287

src/LocalStack.Client.Extensions/README.md

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

33
[![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client)](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/) [![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/) [![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) [![Linux Tests](https://img.shields.io/endpoint?url=https://yvfdbfas85.execute-api.eu-central-1.amazonaws.com/live/badge/tests/linux?label=Tests)](https://yvfdbfas85.execute-api.eu-central-1.amazonaws.com/live/redirect/test-results/linux)
44

5-
> **🚀 Quick Start**: `dotnet add package LocalStack.Client --version 2.0.0-preview1` (AWS SDK v4) | [Installation Guide](#-installation) | [GA Timeline](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)
5+
> **🚀 Quick Start**: `dotnet add package LocalStack.Client --version 2.0.0` (AWS SDK v4) | [Installation Guide](#-installation) | [GA Timeline](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)
66
77
---
88

99
## 🎉 What's New: AWS SDK v4 Support Available
1010

11-
**v2.0.0-preview1** is live with complete AWS SDK v4 support - easier migration than expected!
11+
**v2.0.0** is live with complete AWS SDK v4 support - easier migration than expected!
1212

13-
-**1,099 tests passing** across all frameworks
13+
-**1,168 tests passing** across all frameworks
1414
-**Minimal breaking changes** (just .NET Framework 4.6.2 → 4.7.2 and AWS SDK v3 → v4)
1515
-**Public APIs unchanged** - your code should work as-is!
1616
- 📖 **[Read Full Roadmap](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)**
@@ -143,14 +143,12 @@ LocalStack.NET is available through multiple package sources to support differen
143143

144144
### 📦 Package Installation
145145

146-
#### AWS SDK v4 Preview (v2.0.0-preview1)
147-
148-
For testing AWS SDK v4 compatibility:
146+
To install the latest version of LocalStack.NET with AWS SDK v4 support, use the following command:
149147

150148
```bash
151-
# Install v2.0.0-preview1 with AWS SDK v4 support
152-
dotnet add package LocalStack.Client --version 2.0.0-preview1
153-
dotnet add package LocalStack.Client.Extensions --version 2.0.0-preview1
149+
# Install v2.0.0 with AWS SDK v4 support
150+
dotnet add package LocalStack.Client --version 2.0.0
151+
dotnet add package LocalStack.Client.Extensions --version 2.0.0
154152
```
155153

156154
#### Development Builds (GitHub Packages)
@@ -257,13 +255,13 @@ To build the project, use the following commands based on your operating system:
257255

258256
Windows
259257

260-
```
258+
```powershell
261259
build.ps1
262260
```
263261

264262
Linux
265263

266-
```
264+
```bash
267265
./build.sh
268266
```
269267

@@ -277,13 +275,13 @@ To execute the tests, use the commands below:
277275

278276
Windows
279277

280-
```
278+
```powershell
281279
build.ps1 --target=tests
282280
```
283281

284282
Linux
285283

286-
```
284+
```bash
287285
./build.sh --target=tests
288286
```
289287

src/LocalStack.Client/README.md

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

33
[![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client)](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/) [![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/) [![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) [![Linux Tests](https://img.shields.io/endpoint?url=https://yvfdbfas85.execute-api.eu-central-1.amazonaws.com/live/badge/tests/linux?label=Tests)](https://yvfdbfas85.execute-api.eu-central-1.amazonaws.com/live/redirect/test-results/linux)
44

5-
> **🚀 Quick Start**: `dotnet add package LocalStack.Client --version 2.0.0-preview1` (AWS SDK v4) | [Installation Guide](#-installation) | [GA Timeline](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)
5+
> **🚀 Quick Start**: `dotnet add package LocalStack.Client --version 2.0.0` (AWS SDK v4) | [Installation Guide](#-installation) | [GA Timeline](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)
66
77
---
88

99
## 🎉 What's New: AWS SDK v4 Support Available
1010

11-
**v2.0.0-preview1** is live with complete AWS SDK v4 support - easier migration than expected!
11+
**v2.0.0** is live with complete AWS SDK v4 support - easier migration than expected!
1212

13-
-**1,099 tests passing** across all frameworks
13+
-**1,168 tests passing** across all frameworks
1414
-**Minimal breaking changes** (just .NET Framework 4.6.2 → 4.7.2 and AWS SDK v3 → v4)
1515
-**Public APIs unchanged** - your code should work as-is!
1616
- 📖 **[Read Full Roadmap](https://github.com/localstack-dotnet/localstack-dotnet-client/discussions/45)**
@@ -143,14 +143,12 @@ LocalStack.NET is available through multiple package sources to support differen
143143

144144
### 📦 Package Installation
145145

146-
#### AWS SDK v4 Preview (v2.0.0-preview1)
147-
148-
For testing AWS SDK v4 compatibility:
146+
To install the latest version of LocalStack.NET with AWS SDK v4 support, use the following command:
149147

150148
```bash
151-
# Install v2.0.0-preview1 with AWS SDK v4 support
152-
dotnet add package LocalStack.Client --version 2.0.0-preview1
153-
dotnet add package LocalStack.Client.Extensions --version 2.0.0-preview1
149+
# Install v2.0.0 with AWS SDK v4 support
150+
dotnet add package LocalStack.Client --version 2.0.0
151+
dotnet add package LocalStack.Client.Extensions --version 2.0.0
154152
```
155153

156154
#### Development Builds (GitHub Packages)
@@ -257,13 +255,13 @@ To build the project, use the following commands based on your operating system:
257255

258256
Windows
259257

260-
```
258+
```powershell
261259
build.ps1
262260
```
263261

264262
Linux
265263

266-
```
264+
```bash
267265
./build.sh
268266
```
269267

@@ -277,13 +275,13 @@ To execute the tests, use the commands below:
277275

278276
Windows
279277

280-
```
278+
```powershell
281279
build.ps1 --target=tests
282280
```
283281

284282
Linux
285283

286-
```
284+
```bash
287285
./build.sh --target=tests
288286
```
289287

0 commit comments

Comments
 (0)