docs: add professional readme with full feature coverage and release pipeline hook

Replaces the 8-line placeholder with a complete README covering all four
modules, platform capabilities, quick start, dev setup, configuration
reference, and deployment links. Badges use dynamic shields.io URLs so
version/CI status update automatically on each release.

Wires README review into the release pipeline via a release-it
before:git:release hook and a new item in the pre-deploy checklist.
This commit is contained in:
ginnoir
2026-06-02 19:52:24 -05:00
parent fe4673f1cd
commit 6a1ec8bb7b
3 changed files with 162 additions and 5 deletions
+3
View File
@@ -11,6 +11,9 @@
"release": true,
"releaseName": "v${version}"
},
"hooks": {
"before:git:release": "echo 'Check: README.md reflects current modules and env vars before tagging'"
},
"plugins": {
"@release-it/conventional-changelog": {
"preset": {