git-koi README

README проекта с github.com/yalongwastaken/git-koi. Одним файлом markdown: 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)

Ищем в базе…

Что это?Git koi рисует пиксель-арт карпа кои на основе публичной активности аккаунта на GitHub: языки, вклад, серии дней подряд и последний день превращаются в зацикленный GIF для README профиля.
Это GitHub Action, CLI-утилита или библиотека?Всё сразу: всё построено на одном движке на Rust. Это ночной GitHub Action, который обновляет GIF в README профиля, CLI-утилита для командной строки и библиотека на Rust, опубликованная на crates.io.
Как мне поставить кои в README своего профиля?Добавьте Git koi Action в воркфлоу репозитория вашего профиля на GitHub. Он запускается каждую ночь и использует встроенный токен репозитория, чтобы заново сгенерировать GIF.
Что нужно, чтобы запустить это из командной строки?Либо готовый бинарник со страницы релизов, либо Rust версии не ниже той, что закреплена в Cargo.toml, а также авторизованный GitHub CLI.
От чего зависят внешний вид и движение кои?Языки задают его цвет, вклад заставляет его расти, серии дней подряд отмечают его, а завершившийся день определяет, как он плавает.
Где найти подробную инструкцию по настройке?docs/getting-started.md описывает все три способа использования (Action, CLI и библиотека), а API библиотеки на Rust задокументирован на docs.rs.
Можно ли использовать генератор кои в моём проекте на Rust?Да: тот же движок на Rust, на котором работают Action и CLI, опубликован как библиотека на crates.io, так что его можно встроить прямо в свой код.
Какие есть похожие проекты?claude-pxl, beautify-github-profile, metrics, primitive, claude-pxl, markdown-badges, about-me, McReadme-Card
Автор
yalongwastaken
Размер
0.4 MB
Звёзды
678
Возраст
23 д
Коммиты · 90 дней