diff --git a/README.md b/README.md index b2d369e..b625be6 100644 --- a/README.md +++ b/README.md @@ -17,14 +17,28 @@ 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/kimai-plugin-heatmap +composer require kimai-plugin/heatmap-bundle +bin/console assets:install 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/kimai-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/):