docs: rewrite README for public release + tidy CI/milestones

- README rewritten as a general-purpose, external-user-facing guide
  (what it is, build, install, usage, configuration, contributing, license).
- gitleaks workflow header reduced to a generic description.
- MILESTONES M0 scaffold line genericized.
This commit is contained in:
Sulkta 2026-06-28 19:57:40 -07:00
parent b93246ee74
commit 44267a37f6
3 changed files with 128 additions and 38 deletions

View file

@ -1,16 +1,6 @@
# .forgejo/workflows/gitleaks.yml
#
# Sulkta canonical gitleaks workflow. Drop a copy into every public repo at
# `.forgejo/workflows/gitleaks.yml` after the Forgejo act_runner is registered
#.
#
# Pairs with the pre-receive hook installed on every bare repo — that one is
# the strict enforcement layer (rejects the push); this one provides the
# per-PR red ✗ that branch-protection rules can require before merge.
#
# Layer 1 (this workflow): visible per-PR status, can be a required check.
# Layer 2 (pre-receive hook): strict enforcement at the server.
# Layer 3 (scheduled cron sweep): nightly full-history secret sweep.
# Scan the repository for accidentally-committed secrets with gitleaks on
# every push and pull request. Runs over full history so it catches secrets
# introduced in any commit in the pushed range.
name: gitleaks