docs: rewrite README for public release + add MIT LICENSE

This commit is contained in:
Sulkta 2026-06-28 12:51:08 -07:00
parent 5344541f79
commit 449d403d3b
3 changed files with 156 additions and 87 deletions

View file

@ -1,16 +1,8 @@
# .forgejo/workflows/gitleaks.yml
# Gitleaks secret-scanning workflow.
#
# Gitleaks CI workflow for secret scanning. Use it as a CI secret-scan step, e.g. at
# `.forgejo/workflows/gitleaks.yml` after the Forgejo act_runner is registered
# (after a CI runner is configured).
#
# Pairs with the server-side pre-receive hook — 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 sweep across all repos.
# Scans the repository for committed secrets on every push and pull request,
# so credentials never land in history unnoticed. It runs on a Forgejo/Gitea
# Actions runner; copy it to .github/workflows/ to run it on GitHub Actions too.
name: gitleaks