Skip to content

docs: Redesign README with updated versions and structure - #29

Open
kiro-agent[bot] wants to merge 1 commit into
mainfrom
docs/redesign-readme
Open

docs: Redesign README with updated versions and structure#29
kiro-agent[bot] wants to merge 1 commit into
mainfrom
docs/redesign-readme

Conversation

@kiro-agent

@kiro-agent kiro-agent Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

This pull request was created by @kiro-agent on behalf of @maschnetwork 👻

Comment with /kiro fix to address specific feedback or /kiro all to address everything.
Learn about Kiro Web


Summary

Completely redesigned the README.md with the following improvements:

  • Corrected version numbers to match the actual codebase (Java 25, GraalVM CE 25.0.2, Maven 3.9.14, native-maven-plugin 0.11.5)
  • Added CI badge (GitHub Actions build status)
  • Added MIT-0 license badge
  • Added Table of Contents with anchor links for easy navigation
  • Improved formatting with tables for prerequisites and deployed resources
  • Added CRT comparison table showing benefits vs default HTTP clients
  • Added CI/CD section explaining the GitHub Actions workflow
  • Proper tree characters in the project structure diagram
  • Contributing and License sections linked to their respective files
  • SQL syntax highlighting for the CloudWatch Logs Insights query

What was tested

  • Verified all version numbers against Dockerfile, pom.xml, and template.yaml
  • Confirmed all file paths in project structure match the actual repo layout
  • Validated badge URLs and markdown formatting

…mproved formatting

Co-authored-by: Maximilian Schellhorn <36627945+maschnetwork@users.noreply.github.com>
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.

1 participant