From dd016e1a20737077814ee496ca04a21c2fa0b692 Mon Sep 17 00:00:00 2001 From: Maxwell Weru Date: Thu, 23 Nov 2023 08:55:54 +0300 Subject: [PATCH] Update README.md --- .vscode/ltex.dictionary.en-US.txt | 2 ++ README.md | 58 +++++++++++++++---------------- 2 files changed, 31 insertions(+), 29 deletions(-) create mode 100644 .vscode/ltex.dictionary.en-US.txt diff --git a/.vscode/ltex.dictionary.en-US.txt b/.vscode/ltex.dictionary.en-US.txt new file mode 100644 index 00000000..ecf14c8f --- /dev/null +++ b/.vscode/ltex.dictionary.en-US.txt @@ -0,0 +1,2 @@ +serializer +EventBus diff --git a/README.md b/README.md index 52b4d725..c640c80c 100644 --- a/README.md +++ b/README.md @@ -6,13 +6,13 @@ [![Dependabot](https://badgen.net/badge/Dependabot/enabled/green?icon=dependabot)](https://dependabot.com/) [![license](https://img.shields.io/github/license/tinglesoftware/eventbus.svg)](LICENSE) -This repository contains the code for the `Tingle.EventBus` libraries. This project exists so as to simplify the amount of work required to add events to .NET projects. The existing libraries seem to have numerous complexities in setup especially when it comes to the use of framework concepts like dependency injection and options configuration. At [Tingle Software](https://tingle.software), we use this for all our event-driven architecture that is based on .NET +This repository contains the code for the `Tingle.EventBus` libraries. This project exists to simplify the amount of work required to add events to .NET projects. The existing libraries seem to have numerous complexities in setup especially when it comes to the use of framework concepts like dependency injection and options configuration. At [Tingle Software](https://tingle.software), we use this for all our event-driven architecture that is based on .NET ## Packages |Package|Description| |--|--| -|[`Tingle.EventBus`](https://www.nuget.org/packages/Tingle.EventBus/)|Base of the event bus library to allow you publish and consume events from different transports.| +|[`Tingle.EventBus`](https://www.nuget.org/packages/Tingle.EventBus/)|Base of the event bus library to allow you to publish and consume events from different transports.| |[`Tingle.EventBus.Serializers.NewtonsoftJson`](https://www.nuget.org/packages/Tingle.EventBus.Serializers.NewtonsoftJson/)|Support for serializing events using [Newtonsoft.Json](https://www.nuget.org/packages/Newtonsoft.Json/).| |[`Tingle.EventBus.Transports.Amazon.Abstractions`](https://www.nuget.org/packages/Tingle.EventBus.Transports.Amazon.Abstractions/)|Abstractions for working with Amazon (AWS) based transports.| |[`Tingle.EventBus.Transports.Amazon.Kinesis`](https://www.nuget.org/packages/Tingle.EventBus.Transports.Amazon.Kinesis/)|Transport based on [Amazon Kinesis](https://aws.amazon.com/kinesis/).| @@ -23,7 +23,7 @@ This repository contains the code for the `Tingle.EventBus` libraries. This proj |[`Tingle.EventBus.Transports.Azure.ServiceBus`](https://www.nuget.org/packages/Tingle.EventBus.Transports.Azure.ServiceBus/)|Transport based on [Azure Service Bus](https://azure.microsoft.com/en-us/services/service-bus/).| |[`Tingle.EventBus.Transports.InMemory`](https://www.nuget.org/packages/Tingle.EventBus.Transports.InMemory/)|Transport that works only in memory and in process, useful for testing.| |[`Tingle.EventBus.Transports.Kafka`](https://www.nuget.org/packages/Tingle.EventBus.Transports.Kafka/)|Transport based on the open source [Apache Kafka](https://kafka.apache.org/) platform.| -|[`Tingle.EventBus.Transports.RabbitMQ`](https://www.nuget.org/packages/Tingle.EventBus.Transports.RabbitMQ/)|Transport based on the open source [Rabbit MQ](https://www.rabbitmq.com/) broker.| +|[`Tingle.EventBus.Transports.RabbitMQ`](https://www.nuget.org/packages/Tingle.EventBus.Transports.RabbitMQ/)|Transport based on the open source [RabbitMQ](https://www.rabbitmq.com/) broker.| ## Documentation @@ -31,41 +31,41 @@ A number of the documents below are still a work in progress and will be added a ### Getting started -[Bus Concepts and Configuration](docs/bus-concepts-and-configuration.md) +[Bus Concepts and Configuration](./docs/bus-concepts-and-configuration.md) #### Features -- [Choosing a transport](docs/transport-selection.md) -- [Multiple transports in one bus](docs/multi-transport-one-bus.md) -- [Retries](docs/retries.md) -- [Event and Consumers](docs/events-and-consumers.md) -- [Observability](docs/observability.md) -- [Your first app](docs/your-first-app.md) +- [Choosing a transport](./docs/transport-selection.md) +- [Multiple transports in one bus](./docs/multi-transport-one-bus.md) +- [Retries](./docs/retries.md) +- [Event and Consumers](./docs/events-and-consumers.md) +- [Observability](./docs/observability.md) +- [Your first app](./docs/your-first-app.md) #### How to ... -- [Use configuration](docs/work-configuration.md) -- [Work with Azure IoT Hub](docs/work-with-azure-iot-hub.md) -- [Work with Azure Managed Identities](docs/work-with-azure-managed-identities.md) -- [Advanced Service Bus options](docs/advanced-service-bus-options.md) -- [Work with Feature Management](docs/work-with-feature-management.md) -- [Extend event configuration](docs/extend-event-configuration.md) +- [Use configuration](./docs/work-with-configuration.md) +- [Work with Azure IoT Hub](./docs/work-with-azure-iot-hub.md) +- [Work with Azure Managed Identities](./docs/work-with-azure-managed-identities.md) +- [Advanced Service Bus options](./docs/advanced-service-bus-options.md) +- [Work with Feature Management](./docs/work-with-feature-management.md) +- [Extend event configuration](./docs/extend-event-configuration.md) ## Samples -* [Using IConfiguration to configure the EventBus](./samples/ConfigSample) -* [Simple Consumer](./samples/SimpleConsumer) -* [Simple Publisher](./samples/SimplePublisher) -* [Build a custom event serializer](./samples/CustomEventSerializer) -* [Build a custom event configurator](./samples/CustomEventConfigurator) -* [Consume multiple events in one consumer](./samples/MultiEventsConsumer) -* [Consume same event in multiple consumers](./samples/MultipleConsumers) -* [Publish and consume events from multiple transports of the same type](./samples/MultipleSimilarTransports) -* [Publish and consume events from multiple transports of different types](./samples/MultipleDifferentTransports) -* [In memory background processing](./samples/InMemoryBackgroundProcessing) -* [Using Amazon SQS and SNS](./samples/AmazonSqsAndSns) -* [Receive events from Azure IoT Hub](./samples/AzureIotHub) -* [Using Azure Managed Identity instead of Connection Strings](./samples/AzureManagedIdentity) +- [Using `IConfiguration` to configure the EventBus](./samples/ConfigSample) +- [Simple Consumer](./samples/SimpleConsumer) +- [Simple Publisher](./samples/SimplePublisher) +- [Build a custom event serializer](./samples/CustomEventSerializer) +- [Build a custom event configurator](./samples/CustomEventConfigurator) +- [Consume multiple events in one consumer](./samples/MultiEventsConsumer) +- [Consume same event in multiple consumers](./samples/MultipleConsumers) +- [Publish and consume events from multiple transports of the same type](./samples/MultipleSimilarTransports) +- [Publish and consume events from multiple transports of different types](./samples/MultipleDifferentTransports) +- [In memory background processing](./samples/InMemoryBackgroundProcessing) +- [Using Amazon SQS and SNS](./samples/AmazonSqsAndSns) +- [Receive events from Azure IoT Hub](./samples/AzureIotHub) +- [Using Azure Managed Identity instead of Connection Strings](./samples/AzureManagedIdentity) ## Issues & Comments