diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 22 |
1 files changed, 11 insertions, 11 deletions
@@ -8,12 +8,12 @@ Live at [coffee.gumx.cc](https://coffee.gumx.cc). Source at [git.gumx.cc/ccc](ht ## Features -- **Contributions heatmap** — 53 × 7 grid (Sunday-aligned) covering the past 52 weeks, rendered in SVG. Month labels along the top, Mon/Wed/Fri labels on the left. Today's cell has a visible outline. -- **5-level greyscale scale** — cup counts are bucketed proportionally to `MAX_CUPS` using `Math.round`. A legend is shown below the heatmap. -- **Hover tooltips** — hovering any cell shows the date and cup count in a fixed-position tooltip. -- **Two modes** — local mode (full editing, localStorage) or static site mode (read-only, fetches from a remote URL). -- **Stats** — today's cups, current streak, total cups, and daily average. -- **Light and dark mode** — full `prefers-color-scheme` support via CSS custom properties. The heatmap re-renders if the OS theme changes mid-session. +- **Contributions heatmap**: 53 x 7 grid (Sunday-aligned) covering the past 52 weeks, rendered in SVG. Month labels along the top, Mon/Wed/Fri labels on the left. Today's cell has a visible outline. +- **5-level greyscale scale**: cup counts are bucketed proportionally to `MAX_CUPS` using `Math.round`. A legend is shown below the heatmap. +- **Hover tooltips**: hovering any cell shows the date and cup count in a fixed-position tooltip. +- **Two modes**: local mode (full editing, localStorage) or static site mode (read-only, fetches from a remote URL). +- **Stats**: today's cups, current streak, total cups, and daily average. +- **Light and dark mode**: full `prefers-color-scheme` support via CSS custom properties. The heatmap re-renders if the OS theme changes mid-session. --- @@ -21,7 +21,7 @@ Live at [coffee.gumx.cc](https://coffee.gumx.cc). Source at [git.gumx.cc/ccc](ht | File | Description | |---|---| -| `ccc.html` | The entire application — one self-contained HTML file | +| `ccc.html` | The entire application: one self-contained HTML file | | `data.json` | Example data file for static site mode | | `README.md` | This document | | `LICENSE` | MIT licence | @@ -52,8 +52,8 @@ A hint below the log controls reads: *"click any cell to edit that day's count"* ### Import and Export -- **Export JSON** — downloads your current data as `ccc-data.json`. -- **Import JSON** — opens a file picker; selecting a valid JSON file replaces the current data. Invalid files show an alert. +- **Export JSON**: downloads your current data as `ccc-data.json`. +- **Import JSON**: opens a file picker; selecting a valid JSON file replaces the current data. Invalid files show an alert. The data format is described below. @@ -67,7 +67,7 @@ In static site mode: - All editing controls are hidden. - Import and export are unavailable. -- A **"static site mode — read-only"** notice appears below the title. +- A **"static site mode: read-only"** notice appears below the title. - Data is never written to `localStorage`. To use static site mode, host `ccc.html` and `data.json` on any static hosting service (GitHub Pages, Netlify, etc.), then set `DATA_URL` to the full URL of `data.json`. @@ -116,4 +116,4 @@ Data is stored as a JSON object with a single `entries` key. Each entry is a dat ## Licence -MIT — see [LICENSE](LICENSE). +MIT. see [LICENSE](LICENSE). |