Skip to content

docs: improve README with MIT license, badges, quickstart, and demo G… - #9

Merged
PIsberg merged 1 commit into
mainfrom
improve-readme
May 24, 2026
Merged

docs: improve README with MIT license, badges, quickstart, and demo G…#9
PIsberg merged 1 commit into
mainfrom
improve-readme

Conversation

@PIsberg

@PIsberg PIsberg commented May 24, 2026

Copy link
Copy Markdown
Owner

…IF workflow

  • Add MIT LICENSE file
  • Add badges: License, CI, OpenSSF Scorecard, Bun >=1.0, Platform, Lines of Code
  • Improve Quickstart into a numbered 4-step guide with tips
  • Add demo GIF placeholder comment referencing docs/demo.gif
  • Add License section footer
  • Add tools/demo-commands.sh for asciinema demo recording
  • Add .github/workflows/demo.yml to auto-generate and PR demo GIF on push

…IF workflow

- Add MIT LICENSE file
- Add badges: License, CI, OpenSSF Scorecard, Bun >=1.0, Platform, Lines of Code
- Improve Quickstart into a numbered 4-step guide with tips
- Add demo GIF placeholder comment referencing docs/demo.gif
- Add License section footer
- Add tools/demo-commands.sh for asciinema demo recording
- Add .github/workflows/demo.yml to auto-generate and PR demo GIF on push
@PIsberg
PIsberg merged commit f6a0ee4 into main May 24, 2026
4 checks passed
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