Skip to content

Refresh README showcase and community templates#10

Open
yahav-ohana wants to merge 5 commits intomainfrom
docs/readme-showcase
Open

Refresh README showcase and community templates#10
yahav-ohana wants to merge 5 commits intomainfrom
docs/readme-showcase

Conversation

@yahav-ohana
Copy link
Copy Markdown
Collaborator

Summary

  • Refreshes the README as a product showcase with trust badges, a copy-paste quick start, a benchmark graphic, a high-level architecture diagram, and FAQ entries.
  • Adds GitHub issue forms for bug reports and feature requests, plus generated release-note configuration and a changelog checklist.
  • Aligns the security supported-version table with the v1 README/action examples.

Test plan

  • Parsed the benchmark SVG with Python XML parsing.
  • Parsed GitHub YAML files with Ruby YAML.
  • Checked Cursor lints for README, SECURITY, issue templates, release config, and changelog.
  • Reviewed final git diff against origin/main.

Repo settings

  • Enabled GitHub Discussions for jfrog/boost with gh repo edit --enable-discussions=true.

Made with Cursor

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