Skip to content

Polish the README and add an animated demo - #3

Merged
devmaxxx merged 4 commits into
mainfrom
docs/awesome-readme
Oct 17, 2026
Merged

devmaxxx merged 4 commits into
mainfrom
docs/awesome-readme

Conversation

@devmaxxx

Copy link
Copy Markdown
Owner

Summary

  • Adds a row of quick links and a collapsible table of contents under the badges.
  • Adds an animated terminal demo (assets/demo.svg). scripts/demo.ts builds it from what deniedBy really returns under DEFAULT_DENY, so it cannot drift from the library. Regenerate it with pnpm demo. The SVG uses plain CSS animation. For viewers who turn off motion, it shows the finished screen. It is not shipped in the npm package.
  • Adds two more bypasses to the Why table: trap 'git push' EXIT and a python3 -c one-liner.
  • Adds an FAQ covering why rm -rf $DIR is denied, allowing a trusted deny reason, supported shells, no side effects, and deny-list vs allow-list. Also adds a roadmap built from the known gaps.

This PR is stacked on #1, so its base is #1's branch. Once #1 merges, retarget the base to main; CI runs on PRs into main only.

Test plan

  • pnpm lint and pnpm typecheck pass (scripts/ is now type-checked)
  • Checked rendered frames of the demo in headless Chrome: typing mid-line, and the final screen
  • Every verdict shown in the demo matches deniedBy output
  • Demo animates on the GitHub README page after merge
  • Decide whether to keep the CLI line in the roadmap

Follow awesome-readme conventions: a quick-link row under the badges, a
collapsible table of contents, two more bypass rows in the Why table,
an FAQ for the questions the fail-closed design raises, and a roadmap
built from the known gaps.
scripts/demo.ts renders assets/demo.svg from what deniedBy really
returns under DEFAULT_DENY, so the demo cannot drift from the library.
Regenerate it with `pnpm demo`. The SVG is plain CSS animation, honours
prefers-reduced-motion, and is not shipped in the npm package.
Fix each command's width with textLength so the typing cover lines up in
any monospace font. Hide only .cover elements for reduced-motion
viewers, not every class that starts with "c".
Base automatically changed from fix/close-wrapper-script-and-overflow-bypasses to main October 17, 2026 17:27
@devmaxxx
devmaxxx marked this pull request as ready for review October 17, 2026 17:27
CI ran only for PRs into main, so a PR stacked on another PR's branch
was never tested. Drop the base filter, keep push builds on main, and
add workflow_dispatch for manual runs.
@devmaxxx
devmaxxx merged commit 383b840 into main Oct 17, 2026
5 checks passed
@devmaxxx
devmaxxx deleted the docs/awesome-readme branch October 17, 2026 17:33
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.

1 participant