Skip to content

Improve documentation with status badges #15

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.

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

Merged
merged 1 commit into from
Jun 9, 2025

Conversation

basmussen
Copy link
Contributor

@basmussen basmussen commented Jun 9, 2025

Fixes #14

Summary

  • Enhance README with status badges matching distribution-verifier-maven-plugin style
  • Add comprehensive documentation improvements
  • Provide quick visual indicators of project health

Changes

  • Updated badges to match distribution-verifier-maven-plugin style:
    • GitHub Actions CI badge
    • Maven Central badge using maven-badges.herokuapp.com
    • Apache 2.0 License badge
  • Added Requirements section with Java version support (8, 11, 17, 21)
  • Added Building from Source section
  • Added Running Tests section
  • Improved Contributing section with detailed steps
  • Added License section
  • Fixed Maven groupId in dependency example

Benefits

  • Consistent badge style across dataliquid projects
  • Clear Java version requirements
  • Better onboarding for contributors
  • Professional and complete documentation

- Use same badge style as distribution-verifier-maven-plugin
- Add Java version requirements (8, 11, 17, 21)
- Add Maven requirements
- Add Building from Source section
- Add Running Tests section
- Improve Contributing section with detailed steps
- Add License section
- Fix Maven groupId in dependency example
@basmussen basmussen force-pushed the feature/improve-documentation-badges branch from ca1c642 to 850b36a Compare June 9, 2025 15:58
@basmussen basmussen merged commit b10066c into develop Jun 9, 2025
4 checks passed
@basmussen basmussen deleted the feature/improve-documentation-badges branch June 9, 2025 16:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation with badges
1 participant