ginnoir/famapp
1
0
Fork 0
Code Issues 7 Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
docs/tasks/09-pre-deploy-checklist.md
+4
View File
@@ -2,6 +2,10 @@
Run this before every production deploy (first deploy and each tagged release). Dev-login is intentionally retained behind a double gate; this checklist is what keeps that gate honest.
## README
- [ ] `README.md` reflects the current module list and any env vars added since the last release.
## Env hygiene
- [ ] Server `.env` (next to `deploy/compose.yaml`) does **not** set: