Commit Graph

59 Commits

Author SHA1 Message Date
Thilo Schwarz efd7f2228d Update README.md
Signed-off-by: Thilo Schwarz <th-schwarz@users.noreply.github.com>
2025-03-30 12:54:40 +02:00
thischwa fd997bf6da Add Maven repository and usage instructions to README
Updated the README to include instructions for integrating the project into a Maven-based setup, like adding the repository and dependency configurations. These changes assist developers in easily utilizing the library.
2025-03-30 12:51:56 +02:00
thischwa 0bc1cef900 Fix README badge formatting for GitHub release link
Updated the README to correctly format the GitHub release badge and its hyperlink. This enhances clarity and ensures the badge integrates seamlessly with the text.
2025-03-24 19:06:28 +01:00
thischwa d8726e5e64 Add SonarCloud badges to README
Added badges for quality gate status, security rating, coverage, lines of code, and code smells from SonarCloud. These provide better visibility into the project's code quality and metrics directly from the README.
2025-03-24 15:44:03 +01:00
thischwa 3cd29e4e91 Add release badge to README 2025-03-24 10:00:54 +01:00
thischwa da661e7cd0 Add release badge to README
Included a GitHub release badge to display the latest release version directly in the README. This improves visibility of the project's current state and provides quick access to the release details.
2025-03-23 20:06:07 +01:00
thischwa af757714f4 Update README with corrected javadoc link
Replaced the broken relative javadoc link with a working absolute URL pointing to the hosted documentation. This ensures easier access to the API reference for users.
2025-03-23 13:18:08 +01:00
thischwa 30ffb7c4b4 Add Javadoc generation scripts and enhance README examples
Introduce Javadoc-related files (`javadoc.sh`, `options`, and `packages`) for API documentation generation. Update README to improve clarity on usage examples and remove redundant "Example" headings for a cleaner presentation.
2025-03-23 13:12:45 +01:00
thischwa c39e022e41 Initial commit 2025-03-23 12:12:53 +01:00