search

kushagharahi / homebridge-dahua-alerts

Routes motion alerts for Dahua and Lorex camera streams to homebridge-camera-ffmpeg
27 stars 13 forks source link

Tweak README with inline config comments for clarity #33

Closed longzheng closed 2 years ago

longzheng commented 2 years ago

Added some inline comments to the config JSON in the README to provide some clarity around the different options.

I know some of this is annotated by config.schema.json but for users who's just trying to understand the plugin, hopefully this is helps.

kushagharahi commented 2 years ago

Hi thank you for this contribution! Do you know if someone copy and pastes the config with these comments added, will homebridge ignore the comments?

longzheng commented 2 years ago

Unfortunately no, the comments won't be ignored and so it's invalid. Let me try another approach.

longzheng commented 2 years ago

@kushagharahi I tried another approach by documenting it underneath the config.