Skip to content

Commit 34ca6ed

Browse files
committed
Update README, copyright year, and bump package version
Expanded README with detailed usage and features. Updated LICENSE copyright year to 2026. Bumped package version to 10.0.0-preview2 in project file.
1 parent d45b0f0 commit 34ca6ed

3 files changed

Lines changed: 62 additions & 3 deletions

File tree

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@
186186
same "printed page" as the copyright notice for easier
187187
identification within third-party archives.
188188

189-
Copyright [2020-2025] [Victor A Chavez]
189+
Copyright [2020-2026] [Victor A Chavez]
190190

191191
Licensed under the Apache License, Version 2.0 (the "License");
192192
you may not use this file except in compliance with the License.

README.md

Lines changed: 60 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,60 @@
1-
# CodeChavez.EventBus
1+
# CodeChavez.EventBus.Abstractions
2+
3+
A comprehensive abstraction layer for event bus implementations, providing core interfaces and models for building scalable event-driven architectures in .NET 10.
4+
5+
## Features
6+
7+
- **Producer/Consumer Abstractions**: Core interfaces for publishing and consuming events
8+
- **Configuration Options**: Flexible interfaces for configuring consumer and producer behavior
9+
- **Event Models**: Base classes for domain events and integration events
10+
- **MediatR Integration**: Support for MediatR notifications and handlers
11+
- **Cross-Platform Support**: Built for modern .NET
12+
13+
## Core Components
14+
15+
### Interfaces
16+
17+
#### `IConsumerProducerOptions`
18+
Configuration interface for consumer and producer settings.
19+
```csharp
20+
public interface IConsumerProducerOptions
21+
{
22+
List<string> Servers { get; set; }
23+
string Group { get; set; }
24+
string Client { get; set; }
25+
}
26+
```
27+
28+
#### `IConsumerMultiplexOptions`
29+
Specialized configuration for multiplexed consumer scenarios.
30+
31+
### Installation
32+
33+
```bash
34+
dotnet add package CodeChavez.EventBus.Abstractions
35+
```
36+
37+
## Configuration
38+
39+
Configure consumer and producer options by implementing `IConsumerProducerOptions`:
40+
41+
```csharp
42+
public class EventBusOptions : IConsumerProducerOptions
43+
{
44+
public List<string> Servers { get; set; } = new() { "localhost:9092" };
45+
public string Group { get; set; } = "my-consumer-group";
46+
public string Client { get; set; } = "my-client";
47+
}
48+
```
49+
50+
## Target Framework
51+
52+
- **.NET 10** and higher
53+
54+
## License
55+
56+
This project is part of the CodeChavez community projects.
57+
58+
## Repository
59+
60+
[GitHub - CodeChavez.EventBus](https://github.com/codechavez/CodeChavez.EventBus)

src/CodeChavez.EventBus.Abstractions/CodeChavez.EventBus.Abstractions.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<Title>CodeChavez EventBus Abstractions Library</Title>
1010
<Authors>Victor A Chavez</Authors>
1111
<Product>CodeChavez.EventBus.Abstractions</Product>
12-
<Version>10.0.0-preview1</Version>
12+
<Version>10.0.0-preview2</Version>
1313
<Copyright>2020-2026</Copyright>
1414
<Description>It has all necessary interfaces to be implemented</Description>
1515
<PackageReadmeFile>README.md</PackageReadmeFile>

0 commit comments

Comments
 (0)