Skip to content

Update main README content for v0.1.0 core specification release#24

Merged
meisterware-admin merged 4 commits intomainfrom
docs/readme_update_for_v0.1.0_release
Mar 15, 2026
Merged

Update main README content for v0.1.0 core specification release#24
meisterware-admin merged 4 commits intomainfrom
docs/readme_update_for_v0.1.0_release

Conversation

@meisterware-admin
Copy link
Collaborator

@meisterware-admin meisterware-admin commented Mar 15, 2026

Summary

Updated README.md to reflect the release of OpenPAKT v0.1.0 — Core Specification.

The README now clearly communicates the current specification version, clarifies the project status, and improves the explanation of how the specification relates to implementations such as the Detektor reference CLI.


Type of change

Select all that apply:

  • Specification change
  • Documentation update
  • Example artifact update
  • Governance / repository process update
  • Non-functional cleanup

Specification classification (if applicable)

  • Normative change (affects specification behaviour)
  • Non-normative change (clarification, examples, wording)

Related issue

Closes #

This PR updates project documentation to reflect the v0.1.0 Core Specification release milestone.


What changed

Main updates to the README include:

  • updated specification badge to v0.1.0
  • clarified project status following the v0.1.0 Core Specification release
  • removed wording indicating the project was still evolving toward v0.1
  • refined description of the OpenPAKT architecture and scope
  • clarified separation between the OpenPAKT specification and tool implementations
  • improved explanation of the Detektor reference implementation
  • updated roadmap section to reflect the current milestone progression
  • update Detektor / Detektor CLI content references by adding link to GitHub Detektor repository

Impact

This change improves:

  • project clarity for new readers
  • visibility of the current specification version
  • understanding of OpenPAKT as a specification rather than a single tool
  • credibility of the repository for security engineers and potential adopters

There are no specification behaviour changes.


Compatibility

  • Backward compatible
  • Additive change
  • Breaking change
  • Not applicable

This PR only updates documentation and does not modify the specification itself.


Checklist

  • Change is aligned with OpenPAKT scope
  • Related documentation has been updated if needed
  • Examples have been updated if needed
  • Compatibility impact has been considered
  • This PR does not introduce unnecessary scope expansion

Notes for reviewers

This update prepares the repository README for the OpenPAKT v0.1.0 Core Specification release.

The goal is to ensure the landing page accurately reflects the current project state and communicates the intended architecture:

OpenPAKT specification → scanner implementations (e.g., Detektor) → CI policy evaluation.

@meisterware-admin meisterware-admin added the documentation Improvements or additions to documentation label Mar 15, 2026
@meisterware-admin meisterware-admin marked this pull request as ready for review March 15, 2026 09:56
@meisterware-admin meisterware-admin self-assigned this Mar 15, 2026
@meisterware-admin meisterware-admin merged commit 153a0c8 into main Mar 15, 2026
3 checks passed
@meisterware-admin meisterware-admin deleted the docs/readme_update_for_v0.1.0_release branch March 15, 2026 10:25
@github-project-automation github-project-automation bot moved this from Backlog to Done in Meisterware Roadmap Mar 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

2 participants