Skip to content

docs: fix quick start Maven coordinates #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
thehanslevi wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: fix quick start Maven coordinates #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,26 @@ This is designed for:
Groovy DSL:
```groovy
dependencies {
implementation "com.github.eventhorizonlab:spi-tooling-annotations:<version>"
implementation "io.github.eventhorizonlab:spi-tooling-annotations:<version>"

// --- BELOW ONLY REQUIRED FOR PROJECTS USING @ServiceProvider ---
// Kotlin projects:
kapt "com.github.eventhorizonlab:spi-tooling-processor:<version>"
kapt "io.github.eventhorizonlab:spi-tooling-processor:<version>"

// Java projects:
annotationProcessor("com.github.eventhorizonlab:spi-tooling:<version>")
annotationProcessor("io.github.eventhorizonlab:spi-tooling-processor:<version>")
}
```
Gradle kts:
```kotlin
Comment on lines 45 to 47

@coderabbitai coderabbitai Bot Jun 20, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick | 🔵 Trivial | ⚡ Quick win

Add blank lines around code fences to comply with MD031.

Markdown best practice requires blank lines between text and fenced code blocks for readability and linting compliance.

📝 Proposed fix to add blank lines 
     annotationProcessor("io.github.eventhorizonlab:spi-tooling-processor:<version>")
 }

Gradle kts:
+

dependencies {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
Gradle kts:
```kotlin
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 45-45: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

[warning] 47-47: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 45 - 47, The markdown file does not comply with MD031
by missing blank lines around the code fence. Add a blank line before the
"Gradle kts:" text and another blank line between "Gradle kts:" and the opening
code fence (```kotlin) to ensure proper spacing between text and fenced code
blocks as required by markdown linting standards.

Source: Linters/SAST tools

dependencies {
implementation("com.github.eventhorizonlab:spi-tooling-annotations:<version>")
implementation("io.github.eventhorizonlab:spi-tooling-annotations:<version>")

// --- BELOW ONLY REQUIRED FOR PROJECTS USING @ServiceProvider ---
// Kotlin projects:
kapt("com.github.eventhorizonlab:spi-tooling-processor:<version>")
kapt("io.github.eventhorizonlab:spi-tooling-processor:<version>")
// Java projects:
annotationProcessor("com.github.eventhorizonlab:spi-tooling-processor:<version>")
annotationProcessor("io.github.eventhorizonlab:spi-tooling-processor:<version>")
}
```
➡️ See [Kapt](https://kotlinlang.org/docs/kapt.html#0) for more information
Expand Down