diff --git a/README.md b/README.md index 018a832..5ea0a48 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,31 @@ A standalone dashboard page showing the status of the checks in your Healthchecks.io account. -* single page, no external dependencies -* plain HTML, JS and CSS. Fork and hack on it – no build tools or dev environment needed -* auto-refreshes every 5 minutes -* can display checks from multiple projects -* uses Healthchecks.io read-only API keys, does not expose ping URLs +[See a live example dashboard here](https://cuu508.github.io/). + +* Single page, no external dependencies. +* Plain HTML, JS and CSS. Fork it and hack on it – no build tools or dev environment needed. +* Live-updates every 5 seconds. +* Can display checks from multiple projects. +* Uses Healthchecks.io read-only API keys, does not expose ping URLs. + + +## Dark Theme + +![Dark THeme](/docs/theme-dark.png?raw=true "Dark Theme") + +## Light Theme + +![Light THeme](/docs/theme-light.png?raw=true "Light Theme") + ## How To Use -* fork the repository -* edit `index.html` and replace the API keys in `

` tags -* optionally, you can tweak the colors, font sizes and layout -* put the `index.html` file on a web server (Github pages, S3 bucket, -Netlify, ...), or simply open it as a local file in your browser +* Fork the repository. +* Edit `index.html` and replace the API keys in `

` tags. +* Optionally, you can tweak the colors, font sizes and layout. +* Out the `index.html` file on a web server (Github pages, S3 bucket. +Netlify, ...), or simply open it as a local file in your browser. diff --git a/docs/theme-dark.png b/docs/theme-dark.png new file mode 100644 index 0000000..e1f7454 Binary files /dev/null and b/docs/theme-dark.png differ diff --git a/docs/theme-light.png b/docs/theme-light.png new file mode 100644 index 0000000..afebdfa Binary files /dev/null and b/docs/theme-light.png differ