From 5f830294b0577f0065be08671b875e61048b13a6 Mon Sep 17 00:00:00 2001 From: Steven Polley Date: Mon, 13 Nov 2023 12:14:29 -0700 Subject: [PATCH] update readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 39cdc7a..07883a6 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ It syncs your balance like magic! ### Example docker-compose.yml -The values below are examples only. You can configure as many account pairings as you want using environment variables in a continuous series starting from 0 as shown below. Two example accounts are configured ending in _0 and _1 but a third can be added by adding account numbers/ID with _2. +The values below are examples only, and show how to configure the Questrade and Bitcoin providers. With these providers, you can configure as many account pairings as you want using environment variables in a continuous series starting from 0 as shown below. Two example Questrade accounts are configured ending in _0 and _1 but a third can be added by adding account numbers/ID with _2. See the respective README.md files inside the provider directories for more details. ```yaml version: '3.8' @@ -32,9 +32,15 @@ services: - ynab_secret=98Q_J655F_TAyGnhCCDS4uqRe4R5654DT2d-ZXdssZ - bitcoin_address_0=bc1qg0edu4tr7pza8qsxf576r0eulr2ygt3mhldswg - bitcoin_address_1=bc1qeh0dkdqvjyt646657lge0nxqj67z5xa8zxl8q3 + - bitcoin_address_2=bc1qsfsdqvj4443t64dfssfgexsaqj67z44dsjkfkj - bitcoin_ynab_account=1f5bec0d-f852-2fbe-bbee-02fa98ded566 # Bitcoin addresses map to single YNAB account volumes: - /data/ynab-portfolio-monitor-data:/data ``` +### Static JSON Providers + +If your broker doesn't have a provider available, or if you don't want to connect this application to your brokerage account, there is an offline solution available where you can configure your holdings in local static JSON files - and these only need to be updated if your holdings change such as after a trade has been made, or a stock split. + +For more details, see the README.md files located in the provider directories prefixed with "staticjson". \ No newline at end of file