diff --git a/README.md b/README.md index 0c0622f..07a1db2 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,34 @@ -# ddd-toolkit +# DDD Made Easy: ddd-toolkit ![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/fizzbuds/ddd-toolkit/node.js.yml) ![Codecov](https://img.shields.io/codecov/c/github/fizzbuds/ddd-toolkit) ![NPM Version](https://img.shields.io/npm/v/%40fizzbuds%2Fddd-toolkit) +The `ddd-toolkit` library empowers developers to implement Domain-Driven Design (DDD) best practices for cleaner and more maintainable software. It provides production-ready implementations of core DDD tactical patterns like aggregates, domain events, read models, and repositories. -### Installation +### Focus on your Domain: + +`ddd-toolkit` prioritizes simplicity and avoids unnecessary complexity. You won't need to deal with message brokers, eventual consistency, or asynchronous mechanisms at the outset. This streamlined approach makes it easier to adopt DDD practices and focus on your domain logic. + +### Scalable Design: + +The resulting design fosters a scalable architecture. You can introduce complexity gradually, only when necessary, ensuring your application grows smoothly alongside your business needs. + +### Target Audience: + +This library is ideal for developers who want to: + +Get started with DDD principles. +Simplify DDD implementation in their projects. +Improve code maintainability and testability. + + +## Installation ```bash pnpm add @fizzbuds/ddd-toolkit mongodb@5 ``` -### Usage +## Usage An example of use with [Nest](https://nestjs.com/) can be found on [fizzbuds/nest-ddd-toolkit](https://github.com/fizzbuds/nest-ddd-toolkit) repo.