do readme thing

This commit is contained in:
C committed 2026-07-02 19:05:55 -07:00
1 parent f77b5f33b9
commit ac3e86f27e
1 file changed
+22 -1
+22 -1
View File
@@ -1,3 +1,24 @@
# m5papers3-stockticker
daily portfolio tracker for the m5stack paper s3
Daily portfolio tracker for the M5Stack Paper S3.
![Project photo](https://i.imgur.com/8RX5UDV.jpeg)
## Add your own stock and Wi-Fi info
1. Copy config.h.example to config.h.
2. Open config.h and set WIFI_SSID and WIFI_PASSWORD.
3. Add your API keys in config.h:
- FINNHUB_API_KEY
- ALPHAVANTAGE_KEY
4. Open m5paper-stockticker.ino and edit the myPortfolio[] list with your own symbols, share count, and total cost basis.
Portfolio format:
{ "SYMBOL", shares, costBasis, useAV }
- useAV = false for Finnhub (stocks and ETFs)
- useAV = true for Alpha Vantage (useful for some mutual funds)
## Device-specific note
This project is tuned for the M5Stack Paper S3 and its display size, rotation, and power behavior. Running it on another e-ink display usually requires extra configuration (display driver/init, resolution/layout coordinates, update behavior, and sleep/power handling) before it will render correctly.