Skip to content

Commit 41143aa

Browse files
authored
Update README.md
1 parent 7e07b29 commit 41143aa

File tree

1 file changed

+15
-52
lines changed

1 file changed

+15
-52
lines changed

README.md

Lines changed: 15 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# <img src="https://github.com/CodeShayk/SourceFlow.Net/blob/master/Images/ninja-icon-16.png" alt="ninja" style="width:30px;"/> SourceFlow.Net
2-
[![.Net 9.0](https://img.shields.io/badge/.Net-9.0-blue)](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
3-
[![.Net Standard 2.1](https://img.shields.io/badge/.NetStandard-2.1-blue)](https://github.com/dotnet/standard/blob/v2.1.0/docs/versions/netstandard2.1.md)
42
[![NuGet version](https://badge.fury.io/nu/SourceFlow.Net.svg)](https://badge.fury.io/nu/SourceFlow.Net)
53
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/CodeShayk/SourceFlow.Net/blob/master/LICENSE.md)
64
[![GitHub Release](https://img.shields.io/github/v/release/CodeShayk/SourceFlow.Net?logo=github&sort=semver)](https://github.com/CodeShayk/SourceFlow.Net/releases/latest)
75
[![master-build](https://github.com/CodeShayk/SourceFlow.Net/actions/workflows/Master-Build.yml/badge.svg)](https://github.com/CodeShayk/SourceFlow.Net/actions/workflows/Master-Build.yml)
86
[![master-codeql](https://github.com/CodeShayk/SourceFlow.Net/actions/workflows/Master-CodeQL.yml/badge.svg)](https://github.com/CodeShayk/SourceFlow.Net/actions/workflows/Master-CodeQL.yml)
7+
[![.Net 9.0](https://img.shields.io/badge/.Net-9.0-blue)](https://dotnet.microsoft.com/en-us/download/dotnet/9.0)
8+
[![.Net Standard 2.1](https://img.shields.io/badge/.NetStandard-2.1-blue)](https://github.com/dotnet/standard/blob/v2.1.0/docs/versions/netstandard2.1.md)
99

1010
<p align="center"> </p>
1111
<p align="center">
@@ -21,72 +21,35 @@ SourceFlow.Net empowers developers to build scalable, maintainable applications
2121
## 🌟 Why SourceFlow.Net?
2222
### ✨ Key Features
2323
* 🏗️ Domain-Driven Design Support
24-
- **Aggregate Root Framework** - Base classes and interfaces for DDD aggregates
25-
- **Value Objects** - Immutable value type helpers and generators
26-
- **Domain Events** - Rich domain event publishing and handling
27-
- **Bounded Context Isolation** - Tools for maintaining clean architectural boundaries
28-
* ⚡ CQRS Implementation with Command/Query Segregation
29-
- **Command Pipeline** - Validation, authorization, and middleware support
30-
- **Query Optimization** - Dedicated read models with eventual consistency
31-
- **Mediator Pattern** - Built-in command/query dispatching
32-
- **Projection Engine** - Real-time and batch projection processing
33-
- **Read Model Synchronization** - Automated view materialization
34-
* 📊 Event-First Design with Event Sourcing Foundation
35-
- **Event Replay** - Complete system state reconstruction capabilities
36-
- **Event Correlation** - Track causation and correlation across event streams
37-
- **Eventual Consistency** - Saga pattern implementation for long-running processes
38-
- **Audit Trail** - Immutable audit log for compliance requirements
39-
- **Snapshots** - Automatic snapshot management for performance optimization
24+
* ⚡ CQRS Implementation with Command/Query Segregation
25+
* 📊 Event-First Design with Event Sourcing Foundation
4026
* 🧱 Clean Architecture
41-
- **Improved Maintainability** - well-organized codebase with distinct layers and separation of concerns
42-
- **Increased Modularity** - promotes smaller, well-defined modules or components, each with a specific responsibility
43-
- **Enhanced Testability** - allows focused testing of individual components without the need for complex setups or external dependencies
44-
- **Framework and Database Independence** - allows easy switching of components, databases, or other external dependencies without requiring significant changes to the core application
4527

4628
## 🏁 Getting Started
4729
### 🏢 Installation
4830
nuget add package SourceFlow.Net
4931
> dotnet add package SourceFlow.Net.SqlServer # or your preferred storage
32+
### Developer Guide
33+
This comprehensive guide provides detailed information about the SourceFlow.Net framework, covering everything from basic concepts to advanced implementation patterns and troubleshooting guidelines.
34+
35+
Please click on [Developer Guide](https://github.com/CodeShayk/SourceFlow.Net/wiki/Developer-Guide) for complete details.
5036

51-
### 💼 Quick Setup
52-
``` csharp
53-
// Program.cs
54-
builder.Services.AddSourceFlow()
55-
.UseSqlServerEventStore(connectionString)
56-
.AddAggregate<OrderAggregate>()
57-
.AddProjection<OrderSummaryProjection>();
5837

59-
// Domain Aggregate
60-
public class OrderAggregate : AggregateRoot
61-
{
62-
public void PlaceOrder(OrderId orderId, CustomerId customerId, OrderItems items)
63-
{
64-
// Business logic validation
65-
RaiseEvent(new OrderPlacedEvent(orderId, customerId, items, DateTime.UtcNow));
66-
}
67-
}
38+
## Support
39+
40+
If you are having problems, please let me know by [raising a new issue](https://github.com/CodeShayk/SourceFlow.Net/issues/new/choose).
41+
42+
## License
43+
44+
This project is licensed with the [MIT license](LICENSE).
6845

69-
// Command Handler
70-
public class PlaceOrderHandler : ICommandHandler<PlaceOrderCommand>
71-
{
72-
public async Task HandleAsync(PlaceOrderCommand command)
73-
{
74-
var aggregate = await _repository.GetAsync<OrderAggregate>(command.OrderId);
75-
aggregate.PlaceOrder(command.OrderId, command.CustomerId, command.Items);
76-
await _repository.SaveAsync(aggregate);
77-
}
78-
}
79-
```
8046
## 🤝 Contributing
8147
We welcome contributions! Please see our Contributing Guide for details.
8248
- 🐛 Bug Reports - Create an issue
8349
- 💡 Feature Requests - Start a discussion
8450
- 📝 Documentation - Help improve our docs
8551
- 💻 Code - Submit pull requests
8652

87-
## 📄 License
88-
MIT License - Free for commercial and open source use
89-
9053
<div align="center">
9154
<h3>🚀 Build better software with events as your foundation</h3>
9255
<p><strong>Start your journey with SourceFlow.Net today!</strong></p>

0 commit comments

Comments
 (0)