docs: add README with screenshot
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
parent
338ffb9c19
commit
06e8d4cb78
2 changed files with 40 additions and 0 deletions
40
README.md
Normal file
40
README.md
Normal file
|
|
@ -0,0 +1,40 @@
|
|||
# Kimai Heatmap Plugin
|
||||
|
||||
A GitHub-style activity heatmap for your [Kimai](https://www.kimai.org/) dashboard. See where your time went at a glance.
|
||||
|
||||

|
||||
|
||||
## Features
|
||||
|
||||
- Calendar heatmap showing daily tracked hours over the past year
|
||||
- Project filter dropdown
|
||||
- Click any day to jump to that day's timesheet
|
||||
- Streak counter and summary stats (total hours, daily average, busiest day)
|
||||
- Weekend visual distinction
|
||||
- Respects your configured start-of-week preference
|
||||
- Works with light and dark themes
|
||||
- Responsive — scrollable on small screens, resizes with the browser
|
||||
|
||||
## 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
|
||||
bin/console kimai:reload
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
Requires [Nix](https://nixos.org/):
|
||||
|
||||
```bash
|
||||
nix develop
|
||||
process-compose up # starts MariaDB + Kimai
|
||||
npm test # run JS tests
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT
|
||||
BIN
docs/screenshot.png
Normal file
BIN
docs/screenshot.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Loading…
Add table
Reference in a new issue