publicWagsHome/amcrest2mqtt
1
0
Fork 0
mirror of synced 2026-03-10 04:23:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ci skip] Update README

Browse Source
This commit is contained in:
Daniel Chesterton
2021-02-13 15:18:21 +00:00
parent 8597dd94f5
commit b3f8030fb7
2 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/workflows/publish.yml vendored
View File

@@ -8,6 +8,7 @@ on:
jobs: jobs:
docker-publish: docker-publish:
name: Publish to Docker Hub name: Publish to Docker Hub
if: "!contains(github.event.head_commit.message, '[ci skip]')"
runs-on: ubuntu-20.04 runs-on: ubuntu-20.04
steps: steps:
- name: Checkout code - name: Checkout code

18
README.md
View File

@@ -21,14 +21,6 @@ It exposes events to the `amcrest2mqtt/[SERIAL_NUMBER]/event` MQTT topic. If the
the doorbell status to `amcrest2mqtt/[SERIAL_NUMBER]/doorbell`. If the device supports motion events it will expose motion events the doorbell status to `amcrest2mqtt/[SERIAL_NUMBER]/doorbell`. If the device supports motion events it will expose motion events
to `amcrest2mqtt/[SERIAL_NUMBER]/motion`. to `amcrest2mqtt/[SERIAL_NUMBER]/motion`.
## Buy Me A ~~Coffee~~ Beer 🍻
A few people have kindly requested a way to donate a small amount of money. If you feel so inclined I've set up a "Buy Me A Coffee"
page where you can donate a small sum. Please do not feel obligated to donate in any way - I work on the app because it's
useful to myself and others, not for any financial gain - but any token of appreciation is much appreciated 🙂
<a href="https://www.buymeacoffee.com/dchesterton"><img src="https://img.buymeacoffee.com/api/?url=aHR0cHM6Ly9pbWcuYnV5bWVhY29mZmVlLmNvbS9hcGkvP25hbWU9ZGNoZXN0ZXJ0b24mc2l6ZT0zMDAmYmctaW1hZ2U9Ym1jJmJhY2tncm91bmQ9ZmY4MTNm&creator=dchesterton&is_creating=building%20software%20to%20help%20create%20awesome%20homes&design_code=1&design_color=%23ff813f&slug=dchesterton" height="240" /></a>
## Device Support ## Device Support
The app supports events for any Amcrest device supported by [`python-amcrest`](https://github.com/tchellomello/python-amcrest). The app supports events for any Amcrest device supported by [`python-amcrest`](https://github.com/tchellomello/python-amcrest).
@@ -42,7 +34,7 @@ If you are using a different MQTT prefix to the default, you will need to set th
The easiest way to run the app is via Docker Compose, e.g. The easiest way to run the app is via Docker Compose, e.g.
``` ```yaml
version: "3" version: "3"
services: services:
amcrest2mqtt: amcrest2mqtt:
@@ -67,3 +59,11 @@ The app will not support multiple devices. You can run multiple instances of the
### Non-Docker Environments ### Non-Docker Environments
Docker is the only supported way of deploying the application. The app should run directly via Python but this is not supported. Docker is the only supported way of deploying the application. The app should run directly via Python but this is not supported.
## Buy Me A ~~Coffee~~ Beer 🍻
A few people have kindly requested a way to donate a small amount of money. If you feel so inclined I've set up a "Buy Me A Coffee"
page where you can donate a small sum. Please do not feel obligated to donate in any way - I work on the app because it's
useful to myself and others, not for any financial gain - but any token of appreciation is much appreciated 🙂
<a href="https://www.buymeacoffee.com/dchesterton"><img src="https://img.buymeacoffee.com/api/?url=aHR0cHM6Ly9pbWcuYnV5bWVhY29mZmVlLmNvbS9hcGkvP25hbWU9ZGNoZXN0ZXJ0b24mc2l6ZT0zMDAmYmctaW1hZ2U9Ym1jJmJhY2tncm91bmQ9ZmY4MTNm&creator=dchesterton&is_creating=building%20software%20to%20help%20create%20awesome%20homes&design_code=1&design_color=%23ff813f&slug=dchesterton" height="240" /></a>