Skip to content

Commit a289235

Browse files
committed
chore: update structure diagram
1 parent 1d7a5d1 commit a289235

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,25 @@
1111

1212
## Manifesto
1313

14-
> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — Linus Torvalds
14+
> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — [Linus Torvalds](https://web.archive.org/web/20050404020308/http://www.linuxtimes.net/modules.php?name=News&file=article&sid=145)
1515
1616
## About
1717

1818
Proof of Concept for a RESTful Web Service made with [Spring Boot 3](https://spring.io/blog/2024/02/22/spring-boot-3-2-3-available-now) targeting [JDK 21](https://openjdk.org/projects/jdk/21/)
1919

2020
## Structure
2121

22-
The following is a simplified dependency diagram of modules and main libraries:
22+
![Simplified, conceptual project structure and main application flow](assets/images/structure.svg)
2323

24-
![Dependency Diagram](java.samples.spring.boot.svg)
24+
_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._
2525

2626
## Documentation
2727

2828
```console
2929
http://localhost:9000/swagger/index.html
3030
```
3131

32-
![API Documentation](java.samples.spring.boot-swagger.png)
32+
![API Documentation](assets/images/swagger.png)
3333

3434
## Credits
3535

0 commit comments

Comments
 (0)