Skip to content

Link profile README animations to the Git Jet repository #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PingPongPlus merged 1 commit into from
Nov 3, 2026
Merged

Link profile README animations to the Git Jet repository #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,23 @@ The jet returns to land, the calendar rebuilds, and the animation loops.
1. Copy [this workflow](examples/profile-workflow.yml) into your profile repository
as `.github/workflows/git-jet.yml`.
2. Open **Actions → Git Jet → Run workflow**. It publishes images to `output`.
3. Add this to your README, replacing both `YOUR_USERNAME` values:
3. Add this to your README, replacing `YOUR_USERNAME` with your GitHub username:

```html
<picture>
<source media="(prefers-reduced-motion: no-preference)"
srcset="https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/git-jet.gif">
<img width="960"
src="https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/git-jet.png"
alt="My commit history cleared by a pixel jet">
</picture>
<a href="https://github.com/PingPongPlus/git-jet">
<picture>
<source media="(prefers-reduced-motion: no-preference)"
srcset="https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/git-jet.gif">
<img width="960"
src="https://raw.githubusercontent.com/YOUR_USERNAME/YOUR_USERNAME/output/git-jet.png"
alt="My commit history cleared by a pixel jet">
</picture>
</a>
```

Clicking the animation or its static fallback opens the Git Jet repository.
Existing users can replace their image block with this snippet to add the link.

Updates run **daily**. Set `days: '30'`, `'7'` or `'365'` under the generation
step's `with:` section. The static PNG preserves the full calendar. Flight uses
smooth curves at a steady cruise speed and fires while moving. The default is
Expand Down
Loading