Skip to content

Commit f3662a4

Browse files
authored
Update README.md
Signed-off-by: James Ross <james@flyingrobots.dev>
1 parent 4aaabb4 commit f3662a4

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
[![CI](https://github.com/git-stunts/trailer-codec/actions/workflows/ci.yml/badge.svg)](https://github.com/git-stunts/trailer-codec/actions/workflows/ci.yml)
55
[![license](https://img.shields.io/npm/l/@git-stunts/trailer-codec.svg)](LICENSE)
66

7-
A robust encoder/decoder for structured metadata within Git commit messages. Built with **Hexagonal Architecture** and **Domain-Driven Design (DDD)**.
7+
<img width="420" src="https://github.com/user-attachments/assets/0a3800d9-12c4-4639-b6c3-b1782bf28c96" align="right" />
88

9-
## Key Features
9+
A robust encoder/decoder for structured metadata within Git commit messages.
10+
11+
### Key Features
1012

1113
- **Standard Compliant**: Follows the Git "trailer" convention (RFC 822 / Email headers)
1214
- **DoS Protection**: Built-in 5MB message size limit to prevent attacks
@@ -15,7 +17,7 @@ A robust encoder/decoder for structured metadata within Git commit messages. Bui
1517
- **Case Normalization**: Trailer keys normalized to lowercase for consistency
1618
- **Pure Domain Logic**: No I/O, no Git subprocess execution
1719

18-
## Design Principles
20+
### Design Principles
1921

2022
1. **Domain Purity**: Core logic independent of infrastructure
2123
2. **Type Safety**: Value Objects ensure data validity at instantiation

0 commit comments

Comments
 (0)