Skip to content

Commit 15bbe3c

Browse files
Blind-StrikerBlind-Striker
committed
docs: update README with modernized CI/CD information
✨ Enhanced Documentation ## πŸ“– Updated Content - **CI/CD Badges**: Modern GitHub Actions workflow status badges - **Package Installation**: Dual-source strategy (NuGet.org + GitHub Packages) - **Development Builds**: Instructions for GitHub Packages authentication - **CI Status**: Matrix testing status across Windows/Linux/macOS ## πŸ”„ Badge Updates - βœ… **CI/CD Pipeline**: Cross-platform matrix testing status - βœ… **Security Analysis**: CodeQL scanning and dependency review - βœ… **Automated Publishing**: GitHub Packages development builds - ❌ **Removed**: Deprecated Testspace badge Ready for community testing with development packages! πŸš€
1 parent b57061b commit 15bbe3c

File tree

3 files changed

+99
-27
lines changed

3 files changed

+99
-27
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# LocalStack .NET Client ![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client) [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) [![Space Metric](https://localstack-dotnet.testspace.com/spaces/232580/badge?token=bc6aa170f4388c662b791244948f6d2b14f16983)](https://localstack-dotnet.testspace.com/spaces/232580?utm_campaign=metric&utm_medium=referral&utm_source=badge "Test Cases")
1+
# LocalStack .NET Client ![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client) [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) [![CI/CD Pipeline](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml) [![Security](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml)
22

33
> ## ⚠️ AWS SDK v4 Transition Notice
44
>
@@ -27,16 +27,16 @@ Localstack.NET is an easy-to-use .NET client for [LocalStack](https://github.com
2727

2828
| Package | v1.x (AWS SDK v3) | v2.x (AWS SDK v4) - Development |
2929
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30-
| LocalStack.Client | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) | [![MyGet](https://img.shields.io/myget/localstack-dotnet-client/v/LocalStack.Client.svg?label=myget)](https://www.myget.org/feed/localstack-dotnet-client/package/nuget/LocalStack.Client) |
31-
| LocalStack.Client.Extensions | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.Extensions.svg)](https://www.nuget.org/packages/LocalStack.Client.Extensions/) | [![MyGet](https://img.shields.io/myget/localstack-dotnet-client/v/LocalStack.Client.Extensions.svg?label=myget)](https://www.myget.org/feed/localstack-dotnet-client/package/nuget/LocalStack.Client.Extensions) |
30+
| LocalStack.Client | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) | [![GitHub Packages](https://img.shields.io/github/v/release/localstack-dotnet/localstack-dotnet-client?include_prereleases&label=github%20packages)](https://github.com/localstack-dotnet/localstack-dotnet-client/packages) |
31+
| LocalStack.Client.Extensions | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.Extensions.svg)](https://www.nuget.org/packages/LocalStack.Client.Extensions/) | [![GitHub Packages](https://img.shields.io/github/v/release/localstack-dotnet/localstack-dotnet-client?include_prereleases&label=github%20packages)](https://github.com/localstack-dotnet/localstack-dotnet-client/packages) |
3232

3333
## Continuous Integration
3434

35-
| Build server | Platform | Build status |
36-
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
37-
| Github Actions | Ubuntu | [![build-ubuntu](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-ubuntu.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-ubuntu.yml) |
38-
| Github Actions | Windows | [![build-windows](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-windows.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-windows.yml) |
39-
| Github Actions | macOS | [![build-macos](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-macos.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-macos.yml) |
35+
| Build Platform | Status | Description |
36+
|----------------|--------|-------------|
37+
| **Cross-Platform CI** | [![CI/CD Pipeline](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml) | Matrix testing: Windows, Linux, macOS |
38+
| **Security Analysis** | [![Security](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml) | CodeQL analysis & dependency review |
39+
| **Automated Publishing** | [![Auto Publish](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/publish-dev-github.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/publish-dev-github.yml) | Daily GitHub Packages builds |
4040

4141
## Table of Contents
4242

@@ -81,13 +81,37 @@ For detailed installation and setup instructions, please refer to the [official
8181

8282
## Getting Started
8383

84-
LocalStack.NET is installed from NuGet. To work with LocalStack in your .NET applications, you'll need the main library and its extensions. Here's how you can install them:
84+
LocalStack.NET is available through multiple package sources to support different development workflows.
85+
86+
### πŸ“¦ Package Installation
87+
88+
#### Stable Releases (NuGet.org)
89+
90+
For production use and stable releases:
8591

8692
```bash
8793
dotnet add package LocalStack.Client
8894
dotnet add package LocalStack.Client.Extensions
8995
```
9096

97+
#### Development Builds (GitHub Packages)
98+
99+
For testing latest features and bug fixes:
100+
101+
```bash
102+
# Add GitHub Packages source
103+
dotnet nuget add source https://nuget.pkg.github.com/localstack-dotnet/index.json \
104+
--name github-localstack \
105+
--username YOUR_GITHUB_USERNAME \
106+
--password YOUR_GITHUB_TOKEN
107+
108+
# Install development packages
109+
dotnet add package LocalStack.Client --prerelease --source github-localstack
110+
dotnet add package LocalStack.Client.Extensions --prerelease --source github-localstack
111+
```
112+
113+
> **πŸ”‘ GitHub Packages Authentication**: You'll need a GitHub account and [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `read:packages` permission.
114+
91115
Refer to [documentation](https://github.com/localstack-dotnet/localstack-dotnet-client/wiki/Getting-Started#installation) for more information on how to install LocalStack.NET.
92116

93117
`LocalStack.NET` is a library that provides a wrapper around the [aws-sdk-net](https://github.com/aws/aws-sdk-net). This means you can use it in a similar way to the `AWS SDK for .NET` and to [AWSSDK.Extensions.NETCore.Setup](https://docs.aws.amazon.com/sdk-for-net/latest/developer-guide/net-dg-config-netcore.html) with a few differences. For more on how to use the AWS SDK for .NET, see [Getting Started with the AWS SDK for .NET](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/net-dg-setup.html).

β€Žsrc/LocalStack.Client.Extensions/README.mdβ€Ž

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# LocalStack .NET Client ![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client) [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) [![Space Metric](https://localstack-dotnet.testspace.com/spaces/232580/badge?token=bc6aa170f4388c662b791244948f6d2b14f16983)](https://localstack-dotnet.testspace.com/spaces/232580?utm_campaign=metric&utm_medium=referral&utm_source=badge "Test Cases")
1+
# LocalStack .NET Client ![Nuget](https://img.shields.io/nuget/dt/LocalStack.Client) [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) [![CI/CD Pipeline](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml) [![Security](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml)
22

33
> ## ⚠️ AWS SDK v4 Transition Notice
44
>
@@ -27,16 +27,16 @@ Localstack.NET is an easy-to-use .NET client for [LocalStack](https://github.com
2727

2828
| Package | v1.x (AWS SDK v3) | v2.x (AWS SDK v4) - Development |
2929
| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
30-
| LocalStack.Client | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) | [![MyGet](https://img.shields.io/myget/localstack-dotnet-client/v/LocalStack.Client.svg?label=myget)](https://www.myget.org/feed/localstack-dotnet-client/package/nuget/LocalStack.Client) |
31-
| LocalStack.Client.Extensions | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.Extensions.svg)](https://www.nuget.org/packages/LocalStack.Client.Extensions/) | [![MyGet](https://img.shields.io/myget/localstack-dotnet-client/v/LocalStack.Client.Extensions.svg?label=myget)](https://www.myget.org/feed/localstack-dotnet-client/package/nuget/LocalStack.Client.Extensions) |
30+
| LocalStack.Client | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.svg)](https://www.nuget.org/packages/LocalStack.Client/) | [![GitHub Packages](https://img.shields.io/github/v/release/localstack-dotnet/localstack-dotnet-client?include_prereleases&label=github%20packages)](https://github.com/localstack-dotnet/localstack-dotnet-client/packages) |
31+
| LocalStack.Client.Extensions | [![NuGet](https://img.shields.io/nuget/v/LocalStack.Client.Extensions.svg)](https://www.nuget.org/packages/LocalStack.Client.Extensions/) | [![GitHub Packages](https://img.shields.io/github/v/release/localstack-dotnet/localstack-dotnet-client?include_prereleases&label=github%20packages)](https://github.com/localstack-dotnet/localstack-dotnet-client/packages) |
3232

3333
## Continuous Integration
3434

35-
| Build server | Platform | Build status |
36-
| -------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
37-
| Github Actions | Ubuntu | [![build-ubuntu](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-ubuntu.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-ubuntu.yml) |
38-
| Github Actions | Windows | [![build-windows](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-windows.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-windows.yml) |
39-
| Github Actions | macOS | [![build-macos](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-macos.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/build-macos.yml) |
35+
| Build Platform | Status | Description |
36+
|----------------|--------|-------------|
37+
| **Cross-Platform CI** | [![CI/CD Pipeline](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/ci.yml) | Matrix testing: Windows, Linux, macOS |
38+
| **Security Analysis** | [![Security](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/security.yml) | CodeQL analysis & dependency review |
39+
| **Automated Publishing** | [![Auto Publish](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/publish-dev-github.yml/badge.svg)](https://github.com/localstack-dotnet/localstack-dotnet-client/actions/workflows/publish-dev-github.yml) | Daily GitHub Packages builds |
4040

4141
## Table of Contents
4242

@@ -81,13 +81,37 @@ For detailed installation and setup instructions, please refer to the [official
8181

8282
## Getting Started
8383

84-
LocalStack.NET is installed from NuGet. To work with LocalStack in your .NET applications, you'll need the main library and its extensions. Here's how you can install them:
84+
LocalStack.NET is available through multiple package sources to support different development workflows.
85+
86+
### πŸ“¦ Package Installation
87+
88+
#### Stable Releases (NuGet.org)
89+
90+
For production use and stable releases:
8591

8692
```bash
8793
dotnet add package LocalStack.Client
8894
dotnet add package LocalStack.Client.Extensions
8995
```
9096

97+
#### Development Builds (GitHub Packages)
98+
99+
For testing latest features and bug fixes:
100+
101+
```bash
102+
# Add GitHub Packages source
103+
dotnet nuget add source https://nuget.pkg.github.com/localstack-dotnet/index.json \
104+
--name github-localstack \
105+
--username YOUR_GITHUB_USERNAME \
106+
--password YOUR_GITHUB_TOKEN
107+
108+
# Install development packages
109+
dotnet add package LocalStack.Client --prerelease --source github-localstack
110+
dotnet add package LocalStack.Client.Extensions --prerelease --source github-localstack
111+
```
112+
113+
> **πŸ”‘ GitHub Packages Authentication**: You'll need a GitHub account and [Personal Access Token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `read:packages` permission.
114+
91115
Refer to [documentation](https://github.com/localstack-dotnet/localstack-dotnet-client/wiki/Getting-Started#installation) for more information on how to install LocalStack.NET.
92116

93117
`LocalStack.NET` is a library that provides a wrapper around the [aws-sdk-net](https://github.com/aws/aws-sdk-net). This means you can use it in a similar way to the `AWS SDK for .NET` and to [AWSSDK.Extensions.NETCore.Setup](https://docs.aws.amazon.com/sdk-for-net/latest/developer-guide/net-dg-config-netcore.html) with a few differences. For more on how to use the AWS SDK for .NET, see [Getting Started with the AWS SDK for .NET](https://docs.aws.amazon.com/sdk-for-net/v3/developer-guide/net-dg-setup.html).

0 commit comments

Comments
Β (0)