diff --git a/README.md b/README.md index c3b3ae4..e59c140 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,10 @@ [![Java CI with Maven](https://github.com/Janaka2/DesignPatterns/actions/workflows/maven.yml/badge.svg)](https://github.com/Janaka2/DesignPatterns/actions/workflows/maven.yml) -# Java Design Patterns & Architecture Playground +

Java Design Patterns & Architecture Playground

-A practical Java **design-pattern playbook** for real business engineering decisions. +

+ A practical Java design-pattern playbook for real business engineering decisions. +

This repository is built to answer one question quickly: **"Given this business situation, which pattern should I choose, and why?"** @@ -12,6 +14,16 @@ It is optimized for learning by reading and by running tests: - JUnit tests that demonstrate behavior, - package structure that mirrors design concepts. +## Quick navigation + +- [Start here (recommended reading flow)](#start-here-recommended-reading-flow) +- [Quick pattern-selection playbook](#quick-pattern-selection-playbook) +- [What is included](#what-is-included) +- [Phase roadmap](#phase-roadmap) +- [Pattern index matrix](#pattern-index-matrix) +- [Documentation UX quick links](#documentation-ux-quick-links) +- [Project structure](#project-structure) + ## Start here (recommended reading flow) 1. **Pattern index matrix** (below) @@ -158,6 +170,11 @@ Package: `src/main/java/org/example/ai` ## Pattern index matrix +
+Expand/collapse full matrix + +
+ | Pattern | Intent | When to use | Trade-offs | Real-world example | Test class | |---|---|---|---|---|---| | Singleton | Ensure one shared instance | Shared in-memory config/cache objects | Harder testing, hidden global state risk | Application configuration registry | `SingletonTest`, `SingletonModernPackageTest` | @@ -214,6 +231,8 @@ Package: `src/main/java/org/example/ai` --- +
+ ## Documentation UX quick links