Skip to content

Commit d0d672a

Browse files
committed
docs(root): restructure README with social preview & clearer flow
- Moved social preview image directly under badges for better visibility - Clarified intro with immediate project purpose statement - Streamlined Problem → Solution → Quick Start sequence - Kept adapter usage, key features, and related modules intact
1 parent 4da5c62 commit d0d672a

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,18 @@
1010

1111
---
1212

13+
<p align="center">
14+
<img src="docs/images/social-preview.png" alt="Social preview" width="720"/>
15+
<br/>
16+
<em>Type-safe API responses without boilerplate — powered by Spring Boot & OpenAPI Generator</em>
17+
</p>
18+
19+
**Type-safe client generation with Spring Boot & OpenAPI using generics.**
20+
This repository demonstrates how to extend OpenAPI Generator to work with generics in order to avoid boilerplate, reduce
21+
duplicated wrappers, and keep client code clean.
22+
23+
---
24+
1325
## 📑 Table of Contents
1426

1527
- 📦 [Modules](#-modules-in-this-repository)
@@ -44,18 +56,6 @@ This repository consists of two main modules:
4456

4557
---
4658

47-
<p align="center">
48-
<img src="docs/images/social-preview.png" alt="Social preview" width="720"/>
49-
<br/>
50-
<em>Type-safe API responses without boilerplate — powered by Spring Boot & OpenAPI Generator</em>
51-
</p>
52-
53-
**Type-safe client generation with Spring Boot & OpenAPI using generics.**
54-
This repository demonstrates how to extend OpenAPI Generator to work with generics in order to avoid boilerplate, reduce
55-
duplicated wrappers, and keep client code clean.
56-
57-
---
58-
5959
## 🚀 Problem Statement
6060

6161
Most backend teams standardize responses with a generic wrapper like `ServiceResponse<T>`.

0 commit comments

Comments
 (0)