git-koi README

The project's README from github.com/yalongwastaken/git-koi. As one markdown file: README.md.

Git koi

Git koi draws a pixel-art koi from a GitHub account's public activity. Its languages color it, its contributions grow it, its streaks mark it, and the day that just ended decides how it swims. A nightly workflow puts the koi on a profile README as a looping GIF, the same tool runs from the command line, and the Rust library underneath is published on crates.io.

The author's koi, redrawn every night from the day's activity

The six bodies, white, black, Asagi, tea, gold, and platinum, at each growth stage

Repository Structure

.
├── .github/      workflows, issue forms, and Dependabot
├── docs/         the getting-started guide and the render sheets
├── examples/     the profile workflow and the koi library generator
├── src/          the library and the git-koi command
├── tests/        the public-boundary tests and their fixtures
└── action.yml    the GitHub Action

Usage

Requirements

docs/getting-started.md walks through all three: the Action in a profile workflow, the command line, and the library. The API is documented on docs.rs.

Author

Anthony Yalong

License

MIT. See LICENSE.

git-koi (yalongwastaken/git-koi)

cargo
Searching Database…

540 ·GitHub
Git-koi
What is this?Git koi draws a pixel-art koi fish based on a GitHub account's public activity, turning languages, contributions, streaks and the most recent day into a looping GIF for a profile README.
Is this a GitHub Action, a CLI tool, or a library?It's all three built on one Rust engine: a nightly GitHub Action that updates a profile README GIF, a command-line binary, and a Rust library published on crates.io.
How do I get a koi on my profile README?Add the Git koi Action to your GitHub profile repository's workflow; it runs nightly using the repo's built-in token to regenerate the GIF.
What do I need to run it from the command line?Either a pre-built binary from the releases page, or Rust at or above the version pinned in Cargo.toml, plus an authenticated GitHub CLI.
What determines how the koi looks and moves?Your languages set its color, your contributions make it grow, your streaks mark it, and the day that just ended decides how it swims.
Where do I find detailed setup instructions?docs/getting-started.md walks through all three usage modes (Action, CLI, library), and the Rust library's API is documented on docs.rs.
Can I use the koi generator in my own Rust project?Yes, the same Rust engine that powers the Action and CLI is published as a library on crates.io, so you can embed it directly in your own code.
What are similar projects?claude-pxl, beautify-github-profile, metrics, primitive, claude-pxl, markdown-badges, about-me, McReadme-Card
Which topics is it in?cargo, github-profile-readme, github-profile, profile-readme, readme, pixel-art, gif, generative-art, art, creative-coding, github, github-actions
Creator
yalongwastaken
Size
0.4 MB
Stars
540
Updated
CommitOct 31Releasev1.0.2Oct 31
Age
8d
Commits · 90 Days