From ac3e86f27e8846b0c00dffd3ea2717f43723e4cf Mon Sep 17 00:00:00 2001
From: C <0xicl33n@gmail.com>
Date: Thu, 2 Jul 2026 19:05:55 -0700
Subject: [PATCH] do readme thing

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4d45645..f19bd2b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
 # m5papers3-stockticker
 
-daily portfolio tracker for the m5stack paper s3
\ No newline at end of file
+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.
\ No newline at end of file