Add README.md

This commit is contained in:
Lauri Võsandi 2022-02-16 22:10:35 +02:00 committed by Lauri Võsandi
parent 8cef6d853f
commit 6f78aa83f4
1 changed files with 15 additions and 0 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
# Cloud native motion detection microservice
This software implements the motion detection portion
of well known [motion-project](https://motion-project.github.io/) as
a microservice. For the tiling counterpart see `camera-tiler` repository.
In a nutshell:
- It brings the MJPEG stream into the cluster
- Performs highly optimal JPEG DCT coefficient based motion detection
without actually decoding the JPEG frame to a bitmap
- WIP: Writes events to MongoDB
- WIP: Uploads screenshots to S3
- Exposes endpoint for distributing MJPEG stream inside the cluster,
eg by the `camera-tiler`
- Exposes endpoint for inspecting DCT blocks where motion has been detected