diff --git a/README.md b/README.md index 199b378e8..b61cc8dbc 100644 --- a/README.md +++ b/README.md @@ -14,9 +14,25 @@ Use of a [Google Coral Accelerator](https://coral.ai/products/) is optional, but - Uses a very low overhead motion detection to determine where to run object detection - Object detection with TensorFlow runs in separate processes for maximum FPS - Communicates over MQTT for easy integration into other systems +- Records video clips of detected objects - 24/7 recording - Re-streaming via RTMP to reduce the number of connections to your camera ## Documentation View the documentation at https://blakeblackshear.github.io/frigate + +## Screenshots +Integration into HomeAssistant +
+ + +
+ +Also comes with a builtin UI: +
+ + +
+ +![Events](docs/static/img/events-ui.png) diff --git a/docs/docs/installation.md b/docs/docs/installation.md index 53ceb1f26..3728079c8 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -21,6 +21,7 @@ HassOS users can install via the addon repository. Frigate requires an MQTT serv ## Docker Make sure you choose the right image for your architecture: + |Arch|Image Name| |-|-| |amd64|blakeblackshear/frigate:stable-amd64| diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md index 7053a2158..94d6cb134 100644 --- a/docs/docs/troubleshooting.md +++ b/docs/docs/troubleshooting.md @@ -6,7 +6,6 @@ title: Troubleshooting ### My mjpeg stream or snapshots look green and crazy This almost always means that the width/height defined for your camera are not correct. Double check the resolution with vlc or another player. Also make sure you don't have the width and height values backwards. -Example: ![mismatched-resolution](/img/mismatched-resolution.jpg) ## "[mov,mp4,m4a,3gp,3g2,mj2 @ 0x5639eeb6e140] moov atom not found" diff --git a/docs/static/img/camera-ui.png b/docs/static/img/camera-ui.png new file mode 100644 index 000000000..55418e8be Binary files /dev/null and b/docs/static/img/camera-ui.png differ diff --git a/docs/static/img/events-ui.png b/docs/static/img/events-ui.png new file mode 100644 index 000000000..13ee20592 Binary files /dev/null and b/docs/static/img/events-ui.png differ diff --git a/docs/static/img/home-ui.png b/docs/static/img/home-ui.png new file mode 100644 index 000000000..efdce3a4e Binary files /dev/null and b/docs/static/img/home-ui.png differ