Skip to content

docs(readme): add how-to-use walkthrough GIF above Quick start#52

Merged
yahav-ohana merged 14 commits into
mainfrom
docs/readme-how-to-use-gif
Jul 15, 2026
Merged

docs(readme): add how-to-use walkthrough GIF above Quick start#52
yahav-ohana merged 14 commits into
mainfrom
docs/readme-how-to-use-gif

Conversation

@yahav-ohana

Copy link
Copy Markdown
Collaborator

Summary

  • Adds a README walkthrough GIF (logo intro → install → run a task → boost report) under .github/assets/boost-how-to-use.gif
  • Embeds it above the Quick start section so visitors see the product flow before the install commands

Test plan

  • Confirm the GIF renders on the PR Files changed preview / README preview
  • Confirm placement is directly above ## Quick start
  • Confirm file size (~3.6MB) loads reasonably on github.com/jfrog/boost

Made with Cursor

yahav-ohana and others added 14 commits July 14, 2026 16:26
Show install → run a task → boost report so visitors see the product flow before the install commands.

Co-authored-by: Cursor <[email protected]>
Capture viewport now sizes to the tallest stage so the step tabs stay fully visible when the terminal grows.

Co-authored-by: Cursor <[email protected]>
Hide the unused copy chip and start on install so the README demo only shows stages viewers can follow.

Co-authored-by: Cursor <[email protected]>
Give the Save Tokens tagline a bit more time on screen before the demo starts.

Co-authored-by: Cursor <[email protected]>
Chroma-key the outer canvas so the demo sits cleanly on GitHub’s light and dark README themes.

Co-authored-by: Cursor <[email protected]>
Keep the intro and step tabs opaque; only chroma-key the outer padding so GitHub’s background shows through cleanly.

Co-authored-by: Cursor <[email protected]>
Keep the fixed opacity rules while bringing the asset back to a GitHub-friendly size.

Co-authored-by: Cursor <[email protected]>
Ship dark and light variants via prefers-color-scheme so the demo matches the viewer’s theme while keeping the terminal dark.

Co-authored-by: Cursor <[email protected]>
Hide the animated stage strip (and caret blink) during capture so frames
compress cleanly, then encode at 720px / 192 colors without heavy lossy.

Co-authored-by: Cursor <[email protected]>
Stop keying out near-black logo pixels on the light GIF — that was
erasing the Boost text against the white background.

Co-authored-by: Cursor <[email protected]>
Fix the capture path to boost-logo-light.png; the white wordmark fallback
made Boost invisible on the light-theme intro.

Co-authored-by: Cursor <[email protected]>
Show the full terminal flow: install → boost init → run a task → report.

Co-authored-by: Cursor <[email protected]>
Update the how-to-use GIF report beat to the larger savings figures.

Co-authored-by: Cursor <[email protected]>
Point maintainers at the boost-cli capture script and one-shot npm commands.

Co-authored-by: Cursor <[email protected]>
@yahav-ohana
yahav-ohana merged commit 8e78ee5 into main Jul 15, 2026
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