Skip to content

Commit d0947c7

Browse files
authored
docs(readme): restore badges and workflow images (#629)
Restore README badge rendering, fix getting-started markdown links, and re-add workflow images so documentation displays as intended. Made-with: Cursor
1 parent 6ebcaab commit d0947c7

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

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

33
## Stargazers over time
44

5-
[Stargazers over time](https://starchart.cc/jabrena/cursor-rules-java)
5+
[![Stargazers over time](https://starchart.cc/jabrena/cursor-rules-java.svg?variant=adaptive)](https://starchart.cc/jabrena/cursor-rules-java)
66

7-
[CI Builds](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml)
7+
[![CI Builds](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml/badge.svg)](https://github.com/jabrena/cursor-rules-java/actions/workflows/maven.yaml)
88

99
## Goal
1010

@@ -39,10 +39,10 @@ This project is compatible with any Tool compatible with `Skills`, `Agents` or `
3939

4040
Read the following comprehensive guides to use this project today.
4141

42-
- [Getting started with `System prompts for Java](./documentation/GETTING-STARTED-SYSTEM-PROMPTS.md)`
43-
- [Getting started with `Skills for Java](./documentation/GETTING-STARTED-SKILLS.md)`
44-
- [Getting started with `Pipelines and AI](./documentation/GETTING-STARTED-PIPELINES.md)`
45-
- [Getting started with `Agents](./documentation/GETTING-STARTED-AGENTS.md)`
42+
- [Getting started with `System prompts for Java`](./documentation/GETTING-STARTED-SYSTEM-PROMPTS.md)
43+
- [Getting started with `Skills for Java`](./documentation/GETTING-STARTED-SKILLS.md)
44+
- [Getting started with `Pipelines and AI`](./documentation/GETTING-STARTED-PIPELINES.md)
45+
- [Getting started with `Agents`](./documentation/GETTING-STARTED-AGENTS.md)
4646

4747
## How to use them?
4848

@@ -52,16 +52,20 @@ The SDLC has evolved with the arrival of this new set of AI tooling, enhancing t
5252

5353
In this workflow, the Software engineer interact with models using `User prompts` and in an incremental way you delegate a delegate completely a task or ask help in certain moments. You could use this project to refactor the code generated or delegate the task and associate a System prompt / Skills to that task.
5454

55-
55+
![](./documentation/images/workflow-prompts.png)
5656

5757
### Agent Workflow
5858

5959
`Agents for Java Enterprise development` were designed to help the Software engineer in the implementation phase. The software engineer define good `Specs` and that Specifications are delegated to Agents.
6060

61+
![](./documentation/images/workflow-agents.png)
62+
6163
### Pipelines Workflow
6264

6365
Adding AI tools to your pipeline can provide new opportunities to deliver more value (examples: automatic coding, code refactoring, continuous profiling, and others).
6466

67+
![](./documentation/images/workflow-pipelines.png)
68+
6569
## Limitations
6670

6771
### Lack of determinism
@@ -94,7 +98,6 @@ The repository includes [a collection of examples](./examples/) where you can ex
9498
| 2025-07-10 | ADR-002 | [Cursor Rules scope configuration](./documentation/adr/ADR-002-configure-cursor-rules-manual-scope.md) |
9599
| 2025-07-08 | ADR-001 | [Cursor Rules generation from XML Files](./documentation/adr/ADR-001-generate-cursor-rules-from-xml-files.md) |
96100

97-
98101
## Changelog
99102

100103
- Review the [CHANGELOG](./CHANGELOG.md) for further details

0 commit comments

Comments
 (0)