Skip to content

Commit 9a88823

Browse files
docs: update documentation, refs #6
1 parent e64477a commit 9a88823

3 files changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,8 @@ public class User {
6464

6565
👉 Extended copy-paste flow: [Quickstart](docs/quickstart.md).
6666

67+
🧪 **Working example project:** [equilibrium-test](https://github.com/soulcodingmatt/equilibrium-test) — a ready-to-clone project that demonstrates how the annotations work in practice.
68+
6769
---
6870

6971
## How it works

docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
Guides in this folder go deeper than the [root README](../README.md). Start there for the overview and quickstart; use these pages when you need full detail.
44

5+
**Working example project:** [equilibrium-test](https://github.com/soulcodingmatt/equilibrium-test) — clone and run to see the annotations in action.
6+
57
| Guide | What it covers |
68
|-----------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------|
79
| [Why Project Equilibrium?](why-equilibrium.md) | Benefits, when to use it, when to pick something else |

docs/quickstart.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,6 @@ After `mvn compile`, you get a type such as `com.example.dto.UserDto` (package a
6464

6565
**Done** — no hand-maintained DTO stub for that class.
6666

67+
**Want to see it in action?** Clone the [equilibrium-test](https://github.com/soulcodingmatt/equilibrium-test) project for a ready-to-run example that demonstrates the annotations in a real Maven build.
68+
6769
Next: [Annotations reference](annotations-reference.md) for ignores, multiple variants, nesting, and records/VOs.

0 commit comments

Comments
 (0)