Skip to content

Commit 5699f77

Browse files
authored
Merge pull request #20 from A-Programmer/fix/README
Fix README file
2 parents c9464dd + 630924d commit 5699f77

File tree

2 files changed

+17
-16
lines changed

2 files changed

+17
-16
lines changed

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,13 @@ docs/
44
.vs/
55
.code/
66
.vscode/
7+
.idea/
8+
.qodo/
9+
Samples/BlogApp/.idea/
10+
Samples/BlogApp/.qodo/
11+
Samples/BlogApp/.vs/
12+
Samples/BlogApp/.code/
13+
Samples/BlogApp/.vscode/
714
src/.vs/
815
**/.DS_Store
916
**/.DS_Store?

README.md

Lines changed: 10 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# KSFramework
22

3-
**KSFramework** is a modular and extensible .NET framework that simplifies the implementation of enterprise-grade applications using **Clean Architecture**, **DDD**, and **CQRS** patterns. It includes built-in support for Generic Repository, Unit of Work, and a custom MediatR-style messaging system.
3+
**KSFramework** is a modular and extensible .NET framework that simplifies the implementation of enterprise-grade applications using **Clean Architecture**, **DDD**, and **CQRS** patterns. It includes built-in support for Generic Repository, Unit of Work, and a custom MediatR-style messaging system, some useful extension methods, helpers, common Enums, Common Exceptions, Unified API Result, Common Specifications, Pagination Helper, Common Responses, .NET Core Tag Helpers and some Utilities.
44

55
---
66

@@ -32,6 +32,13 @@ dotnet add package KSFramework
3232
- `KSFramework.KSDomain` — Domain primitives: `Entity`, `AggregateRoot`, `ValueObject`
3333
- `KSFramework.GenericRepository``Repository`, `UnitOfWork`, pagination support
3434
- `KSFramework.KSMessaging` — CQRS with internal MediatR-style handler resolver, behaviors, stream handling
35+
- `KSFramework.Enums` - Common Enums
36+
- `KSFramework.Exceptions` - Common Exceptions
37+
- `KSFramework.KSApi` - Unified API Result
38+
- `KSFramework.Pagination` - Pagination Helper
39+
- `KSFramework.Responses` - Common Responses
40+
- `KSFramework.TagHelpers` - .NET Core Tag Helpers
41+
- `KSFramework.Utilities` - Common Utiliti Extension Methods
3542

3643
---
3744

@@ -40,7 +47,7 @@ dotnet add package KSFramework
4047
### 🧱 Register Services (Program.cs)
4148

4249
```csharp
43-
builder.Services.AddKSMediator(typeof(Program).Assembly);
50+
builder.Services.AddKSMediator(typeof(Program).Assembly); // Pass the assembly (array of assemblies) that your MediatR Handlers located in, like Application Project
4451
builder.Services.AddScoped<IUnitOfWork, UnitOfWork>();
4552
```
4653

@@ -160,9 +167,7 @@ public class WeeklyNewsletterJob
160167

161168
foreach (var s in subscribers)
162169
{
163-
await EmailSender.Send(s.Email, "Your Weekly Digest", string.Join("
164-
165-
", posts.Select(p => p.Title)));
170+
await EmailSender.Send(s.Email, "Your Weekly Digest", string.Join("\n", posts.Select(p => p.Title)));
166171
}
167172
}
168173
}
@@ -178,17 +183,6 @@ public class WeeklyNewsletterJob
178183

179184
---
180185

181-
## 📌 Roadmap
182-
183-
- [x] Internal MediatR/CQRS support
184-
- [x] Pagination
185-
- [x] Unit of Work abstraction
186-
- [ ] ValidationBehavior
187-
- [ ] ExceptionHandlingBehavior
188-
- [ ] Domain Events integration
189-
190-
---
191-
192186
## 📄 License
193187

194188
Licensed under MIT.

0 commit comments

Comments
 (0)