lysann/trmnl-bring-plugin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Yashar Dabiran 2025-02-13 23:41:44 -05:00 • committed by GitHub
parent f329d855cf
commit 5b8c49f05a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -22,7 +22,7 @@ You then need to create the view templates for your plugin. Go to the Edit Marku
### 2. Run the backend service ### 2. Run the backend service
The backend service queries Bring! every 15 minutes to grab the list of items in your shopping list and sends the list to TRMNL if the shopping list changed since the last query. The backend service runs indefinitely, queries Bring! every 15 minutes to grab the list of items in your shopping list and sends the list to TRMNL if the shopping list changed since the last query.
Have these handy: Have these handy:
@ -32,7 +32,11 @@ Have these handy:
*Note:* If you signed up to Bring! using Apple ID or Google Sign-in or other SSOs you need to create password first. More [here](https://www.home-assistant.io/integrations/bring/#prerequisites). *Note:* If you signed up to Bring! using Apple ID or Google Sign-in or other SSOs you need to create password first. More [here](https://www.home-assistant.io/integrations/bring/#prerequisites).
You can either run the backend service through docker: You can either run the backend service through docker or run the script directly.
#### Docker
Pull the docker image and pass the email, password and webhook url as env variables.
```bash ```bash
docker pull ghcr.io/yshrdbrn/trmnl-bring-plugin:main docker pull ghcr.io/yshrdbrn/trmnl-bring-plugin:main
@ -46,7 +50,9 @@ docker run
'ghcr.io/yshrdbrn/trmnl-bring-plugin:main' 'ghcr.io/yshrdbrn/trmnl-bring-plugin:main'
``` ```
or run the script directly: #### Run the script directly
Clone the repo and rename `.env.example` to `.env` and put in your email, password and webhook url there. Then run the script:
```bash ```bash
python3 -m venv venv python3 -m venv venv