diff --git a/README.md b/README.md
index 1fb0cc4..831765a 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,16 @@
# Frigate-notify
+
+
+![Static Badge](https://img.shields.io/badge/Project-Documentation-blue?link=https://frigate-notify.0x2142.com) ![GitHub Repo stars](https://img.shields.io/github/stars/0x2142/frigate-notify) ![GitHub release (with filter)](https://img.shields.io/github/v/release/0x2142/frigate-notify)
+
+
+
## About
This project is designed to generate notifications based on [Frigate](https://github.com/blakeblackshear/frigate) NVR events.
-Currently Frigate only supports notifications through Home Assistant, which I don't use. So I set out to build a simple notification app that would work with a standalone Frigate server.
+Currently Frigate only supports notifications through Home Assistant, which I'm not using right now. So I set out to build a simple notification app that would work with a standalone Frigate server.
## Features
@@ -20,43 +26,16 @@ Currently Frigate only supports notifications through Home Assistant, which I do
**Other**
- Aliveness monitor via HTTP GET (for use with tools like [HealthChecks](https://github.com/healthchecks/healthchecks) or [Uptime Kuma](https://github.com/louislam/uptime-kuma))
-## Setup
-
-### Configuration
-
-An example config file has been provided (`example-config.yml`). Please copy this & edit to fit your needs.
-
-The example config file contains additional details about how to configure the app. A few important notes:
-- Only one event polling method can be configured - Either MQTT or API.
-- Regardless of polling method, app needs access to Frigate API to pull screenshots
-- Any combination of notification services can be enabled
-By default, this app will look for a configuration file in the local directory named `config.yml`.
-- This can be changed via `-c` flag (example: `./frigate-notify -c newconfig.yml`)
-- or specifying a location via environment variable: `FN_CONFIGFILE`
+## Installation
+See [Install / Setup](https://frigate-notify.0x2142.com/install/).
-### Run
+## Configuration
-Run locally with
-```bash
-$ ./frigate-notify
-```
-
-Or as a container:
-```bash
-$ docker run -v /path/to/config.yml:/app/config.yml ghcr.io/0x2142/frigate-notify:latest
-```
-
-A docker-compose file has also been provided. Please modify the config path before using.
-
-## Future
-
-Just a quick list of things I may add later:
-- Dampening time between notifications
-- Additional alerting methods
+An example config file has been provided (`example-config.yml`). Please copy this & edit to fit your needs.
-> If you use this code & have any specific feature requests - please feel free to open an issue with the details of what you would like to see added
+The sample config contains inline descriptions for each field. For additional details on the available config options & the defaults, see the [Config](https://frigate-notify.0x2142.com/config/) docs.
## Screenshots
@@ -66,4 +45,8 @@ Just a quick list of things I may add later:
**Gotify**
-![Gotify](/screenshots/gotify.png)
\ No newline at end of file
+![Gotify](/screenshots/gotify.png)
+
+## Changelog
+
+Additional details on each release are in the [Changelog](https://frigate-notify.0x2142.com/changelog/)
\ No newline at end of file
diff --git a/docs/index.md b/docs/index.md
index b44b82c..b65b48b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -35,4 +35,6 @@ Currently Frigate only supports notifications through Home Assistant, which I'm
Thanks again for being here! 😊
-
\ No newline at end of file
+
+
+
\ No newline at end of file
diff --git a/mkdocs.yml b/mkdocs.yml
index f749fd5..4d95547 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -9,11 +9,17 @@ repo_url: https://github.com/0x2142/frigate-notify
theme:
name: material
palette:
- - scheme: slate
+ - media: "(prefers-color-scheme)"
+ toggle:
+ icon: material/brightness-auto
+ name: Switch to light mode
+ - media: "(prefers-color-scheme: dark)"
+ scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
- - scheme: default
+ - media: "(prefers-color-scheme: light)"
+ scheme: default
toggle:
icon: material/weather-night
name: Switch to dark mode