prepare for composer distribution

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Christopher Mühl 2026-04-08 20:10:10 +02:00
parent fb0f9c384b
commit 3c10cdd8b0
No known key found for this signature in database
GPG key ID: 925AC7D69955293F
2 changed files with 28 additions and 4 deletions

View file

@ -17,14 +17,27 @@ A GitHub-style activity heatmap for your [Kimai](https://www.kimai.org/) dashboa
## Installation
Copy the plugin into your Kimai `var/plugins/` directory:
```bash
cd /path/to/kimai
git clone https://github.com/toph/kimai-heatmap.git var/plugins/KimaiHeatmapBundle
composer config repositories.heatmap vcs https://git.toph.so/toph/kimea-plugin-heatmap
composer require kimai-plugin/heatmap-bundle
bin/console kimai:reload
```
If you can't run `composer require` directly (e.g. Docker Compose, Nomad, or a custom image), add this to your `composer.json` instead:
```json
{
"repositories": [
{ "type": "vcs", "url": "https://git.toph.so/toph/kimea-plugin-heatmap" }
],
"require": {
"kimai-plugin/heatmap-bundle": "^1.0"
}
}
```
Then rebuild your image or run `composer install` in the container.
## Development
Requires [Nix](https://nixos.org/):

View file

@ -3,6 +3,17 @@
"type": "kimai-plugin",
"description": "GitHub-style activity heatmap dashboard widget for Kimai",
"license": "MIT",
"keywords": ["kimai", "plugin", "heatmap", "dashboard", "time-tracking"],
"homepage": "https://git.toph.so/toph/kimea-plugin-heatmap",
"authors": [
{
"name": "Christopher Mühl",
"homepage": "https://toph.so"
}
],
"require": {
"php": ">=8.2"
},
"autoload": {
"psr-4": {
"KimaiPlugin\\KimaiHeatmapBundle\\": "src/"