From 503dc06d31776266f645ada6756ac5138f9f552c Mon Sep 17 00:00:00 2001 From: CoderDeltaLAN Date: Tue, 9 Jun 2026 12:28:29 +0100 Subject: [PATCH] docs: update post-release status --- CHANGELOG.md | 5 ++++- README.md | 27 ++++++++++++++++++++++----- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index db08d32..3910189 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,7 +6,10 @@ This project has no stable public release yet. ## [Unreleased] -No unreleased changes yet. +### Changed + +- Updated README status after publishing `v0.1.0` as a GitHub pre-release. +- Added basic installation guidance for release artifacts. ## [0.1.0] - 2026-06-09 diff --git a/README.md b/README.md index e89b5f0..eab7c74 100644 --- a/README.md +++ b/README.md @@ -150,12 +150,26 @@ A clean report means only that the implemented baseline checks did not find a su --- -## Commands +## Installation + +`v0.1.0` is available as GitHub pre-release artifacts. + +This project is not published to PyPI yet. + +Download the wheel from the `v0.1.0` GitHub Release, then install it in a virtual environment: + + python -m venv .venv + .venv/bin/python -m pip install ./agent_rules_kit-0.1.0-py3-none-any.whl + .venv/bin/agent-rules-kit --version -The project can currently be used from the source tree with: +The source tree can still be used directly for development: PYTHONPATH=src python -m agent_rules_kit.cli --help +--- + +## Commands + ### Check a repository PYTHONPATH=src python -m agent_rules_kit.cli check tests/fixtures/repositories/single-agent @@ -313,21 +327,24 @@ The required status check for `main` is: Current status: -- v0.1.0 release-candidate documentation stage; +- `v0.1.0` is published as a GitHub pre-release; - no public stable release yet; +- release tag `v0.1.0` points to the verified release SHA; +- wheel and sdist artifacts are attached to the GitHub Release; +- release assets were downloaded, checksum-verified, installed, and smoke-tested; - local CLI behavior implemented; -- packaging verified from real sdist and wheel artifacts; - CI active; - branch protection active; - README reflects current behavior only; - security boundaries documented; - threat model documented. -Before a public release, verify: +For future releases, verify: - local checks pass; - CI passes for the release SHA; - sdist and wheel build and install from clean temporary environments; +- release assets can be downloaded, checksum-verified, installed, and smoke-tested; - output examples are generated from real commands; - README does not claim unsupported maturity; - SECURITY.md and CHANGELOG.md are current;