Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@
<img src="./images/logo-light.svg" alt="Unifinity" width="75" />
</picture>

[![.NET](https://github.com/jasonshave/JasonShave.AzureStorage.QueueService/actions/workflows/dotnet.yml/badge.svg)](https://github.com/jasonshave/JasonShave.AzureStorage.QueueService/actions/workflows/dotnet.yml)
[![Nuget](https://github.com/jasonshave/JasonShave.AzureStorage.QueueService/actions/workflows/nuget.yml/badge.svg)](https://github.com/jasonshave/JasonShave.AzureStorage.QueueService/actions/workflows/nuget.yml)
[![.NET](https://github.com/jasonshave/AzureStorage.QueueService/actions/workflows/dotnet.yml/badge.svg)](https://github.com/jasonshave/AzureStorage.QueueService/actions/workflows/dotnet.yml)
[![Nuget](https://github.com/jasonshave/AzureStorage.QueueService/actions/workflows/nuget.yml/badge.svg)](https://github.com/jasonshave/AzureStorage.QueueService/actions/workflows/nuget.yml)

This project abstracts away the complexities of using the Azure Storage account's queue feature targeting .NET 6 and higher.
> **This is the documentation for 2.x**, the maintenance line for .NET 8, which keeps receiving fixes. On .NET 10, use 3.0 instead: a new API with a hosted message processor. See the [3.0 README](https://github.com/jasonshave/AzureStorage.QueueService#readme), including its [upgrade guide](https://github.com/jasonshave/AzureStorage.QueueService#upgrading-from-2x).

This project abstracts away the complexities of using the Azure Storage account's queue feature targeting .NET 8.

## Pre-requisites

Expand All @@ -30,7 +32,7 @@ You will need to create an Azure Storage account in the Azure portal using a uni

## Configuration

1. Add the Nuget package `JasonShave.AzureStorage.QueueService` to your .NET project
1. Add the NuGet package [`AzureStorage.QueueService`](https://www.nuget.org/packages/AzureStorage.QueueService) to your .NET project
2. Set your `ConnectionString` and `QueueName` properties in your [.NET User Secrets store](https://docs.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-6.0&tabs=windows), `appsettings.json`, or anywhere your `IConfiguration` provider can look for the `QueueClientSettings`. For example:

```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@
<Description>A library used to read from an Azure Storage Queue. Use this package in combination with code samples for Azure Communication Services projects where Event Grid subscriptions from a storage queue are used.</Description>
<Copyright>Unifinity Software Corporation</Copyright>
<PackageTags>Azure, Azure Storage, Azure Storage Queue, Storage Queue, Queue Service, Jason Shave, Unifinity Software Corporation</PackageTags>
<PackageProjectUrl>https://github.com/jasonshave/JasonShave.AzureStorage.QueueService</PackageProjectUrl>
<PackageProjectUrl>https://github.com/jasonshave/AzureStorage.QueueService</PackageProjectUrl>
<PackageIcon>logo.png</PackageIcon>
<PackageReadmeFile>README.md</PackageReadmeFile>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/jasonshave/JasonShave.AzureStorage.QueueService</RepositoryUrl>
<RepositoryUrl>https://github.com/jasonshave/AzureStorage.QueueService</RepositoryUrl>
<Authors>Unifinity Software Corporation</Authors>
<AssemblyVersion></AssemblyVersion>
<Version>$(VersionPrefix)</Version>
Expand Down
Loading