git-koi 1.0.2

Draw a pixel-art koi from a GitHub account's public activity, as a looping GIF for a profile README.
Documentation

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.

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

  • For a koi on your profile README: a GitHub account. The Action runs in your profile repository's workflow with its built-in token.
  • For the command line: a binary from the releases page, or Rust at or above the rust-version in Cargo.toml, plus the GitHub CLI, authenticated.
  • For the library: Rust at or above that same version.

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.