Skip to content

Commit 2abf103

Browse files
wesmclaude
andcommitted
docs: Add screenshots to usage examples and setup guide
Added screenshots from moneyflow-assets repository to illustrate key workflows and setup process: Setup section: - backend-select.png: Shows backend selection modal - monarch-credentials.png: Shows credential setup form with 2FA Usage examples: - drill-down-bulk-edit-merchant.png: Merchant editing modal - drill-down-edit-category.png: Category selection with autocomplete - drill-down-group-by-category.png: Sub-grouping feature (drill + group) - drill-down-detail.png: Transaction detail view after drilling down - drill-down-detail-multi-select.png: Multi-select with checkmarks New sections added: - "Drill Down and Sub-Grouping" - Shows the powerful navigation feature - "Multi-Select for Bulk Operations" - Illustrates bulk editing All screenshots link to github.com/wesm-ursalabs/moneyflow-assets for easy updating and maintenance. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent dd854a7 commit 2abf103

File tree

1 file changed

+52
-11
lines changed

1 file changed

+52
-11
lines changed

README.md

Lines changed: 52 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -167,20 +167,30 @@ moneyflow --help
167167

168168
## First Run Setup (Monarch Money)
169169

170-
On first run, moneyflow will guide you through credential setup:
170+
On first run, moneyflow will guide you through credential setup.
171171

172-
1. **Get your 2FA secret** (before starting):
173-
- Log into Monarch Money → Settings → Security
174-
- Disable and re-enable 2FA
175-
- Click "Can't scan?" to view the secret key
176-
- Copy the BASE32 secret (e.g., `JBSWY3DPEHPK3PXP`)
172+
### Step 1: Select Backend
177173

178-
2. **Launch moneyflow** and enter when prompted:
179-
- Monarch Money email and password
180-
- Your 2FA secret key
181-
- A new encryption password (for moneyflow only)
174+
![Backend selection](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/backend-select.png)
182175

183-
3. **Done!** Next time, just enter your encryption password.
176+
Choose which platform you want to connect to (currently only Monarch Money is fully supported).
177+
178+
### Step 2: Enter Credentials
179+
180+
![Credential setup](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/monarch-credentials.png)
181+
182+
**Before starting, get your 2FA secret:**
183+
1. Log into Monarch Money → Settings → Security
184+
2. Disable and re-enable 2FA
185+
3. Click "Can't scan?" to view the secret key
186+
4. Copy the BASE32 secret (e.g., `JBSWY3DPEHPK3PXP`)
187+
188+
**Then enter in moneyflow:**
189+
- Monarch Money email and password
190+
- Your 2FA secret key
191+
- A new encryption password (for moneyflow only)
192+
193+
**Done!** Next time, just enter your encryption password.
184194

185195
Your credentials are encrypted with AES-128 and stored in `~/.moneyflow/credentials.enc`.
186196

@@ -200,6 +210,8 @@ moneyflow downloads all transactions once, then filters client-side for instant
200210

201211
### Clean Up Merchant Names
202212

213+
![Edit merchant from aggregate view](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/drill-down-bulk-edit-merchant.png)
214+
203215
```
204216
1. Launch: moneyflow
205217
2. Press 'g' to cycle to merchants view
@@ -211,6 +223,8 @@ moneyflow downloads all transactions once, then filters client-side for instant
211223

212224
### Bulk Edit Categories
213225

226+
![Edit category with multi-select](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/drill-down-edit-category.png)
227+
214228
```
215229
1. Press 'u' to view all transactions
216230
2. Press Space to select multiple transactions (shows ✓)
@@ -219,6 +233,33 @@ moneyflow downloads all transactions once, then filters client-side for instant
219233
5. Press 'w' to review, then Enter to commit
220234
```
221235

236+
### Drill Down and Sub-Grouping
237+
238+
![Drill into merchant and group by category](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/drill-down-group-by-category.png)
239+
240+
Drill into any merchant or category, then press 'g' to cycle through sub-groupings:
241+
242+
```
243+
1. From merchants view, press Enter on "Amazon"
244+
2. Press 'g' to group by category (shows Amazon transactions by category)
245+
3. Press 'g' again to group by account
246+
4. Press 'g' again to show detail view
247+
5. Press Esc to go back to merchants view
248+
```
249+
250+
![Transaction detail view](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/drill-down-detail.png)
251+
252+
### Multi-Select for Bulk Operations
253+
254+
![Multi-select transactions](https://raw.githubusercontent.com/wesm-ursalabs/moneyflow-assets/main/drill-down-detail-multi-select.png)
255+
256+
```
257+
1. Navigate to any detail view
258+
2. Press Space to select transactions (shows ✓)
259+
3. Press 'm' or 'c' to bulk edit selected transactions
260+
4. Press 'w' to review and commit
261+
```
262+
222263
### Monthly Spending Review
223264

224265
```

0 commit comments

Comments
 (0)