Skip to content

docs: align README with source and published releases - #52

Open
somethingwithproof wants to merge 3 commits into
developfrom
docs/readme-source-and-releases
Open

somethingwithproof wants to merge 3 commits into
developfrom
docs/readme-source-and-releases

Conversation

@somethingwithproof

Copy link
Copy Markdown
Member

Updates the README to distinguish current source requirements from the latest published package, with values checked against both INFO files. Clarifies the installation directory and version-history links and corrects stale behavior where the implementation differs.

Validation: source/tag metadata and plugin lifecycle identity checked; local links and Markdown tables checked; historical changelog content preserved; git diff --check passes. Documentation only.

Fixes #51

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
Re-checked the documentation against INFO, setup.php, the settings
arrays, registered realms and CLI usage text, and fixed the statements
that did not match. Adds the realms, settings and command line tools
the README did not mention.

Signed-off-by: Thomas Vincent <thomasvincent@gmail.com>
@sonarqubecloud

Copy link
Copy Markdown

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.

Refresh README for current code and published releases

1 participant