Skip to content

Commit ebd2378

Browse files
committed
Update README
Signed-off-by: birkhoff <git@birkhoff.me>
1 parent c4cac44 commit ebd2378

File tree

1 file changed

+45
-45
lines changed

1 file changed

+45
-45
lines changed

README.md

Lines changed: 45 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,51 @@ A Terminal User Interface (TUI) application for analyzing credit card statements
1818
- **Sorting**: Sort transactions by date, amount, or location
1919
- **Interactive Navigation**: Browse statements and transactions with keyboard shortcuts, sorting, and filtering
2020

21+
## Usage
22+
23+
```bash
24+
./statements <path-to-statement-list.json>
25+
```
26+
27+
## Keyboard Controls
28+
29+
### All Views
30+
- `Tab` - Switch between Summary and Statements views
31+
- `q` or `Ctrl+C` - Quit the application
32+
33+
### Statements View
34+
- `` or `k` - Select previous statement
35+
- `` or `j` - Select next statement
36+
- `` or `h` - Navigate to previous transaction
37+
- `` or `l` - Navigate to next transaction
38+
- `s` - Cycle through sort modes (Date → Amount → Location)
39+
40+
## Views
41+
42+
### Summary View
43+
Displays an overview of all transactions:
44+
- Total number of statements
45+
- Transaction counts by category
46+
- Apple Pay breakdown by card (last 4 digits)
47+
- PayPal transaction summary
48+
- Foreign transaction fee summary
49+
50+
### Statements View
51+
Browse statements with two panels:
52+
53+
**Left Panel (Statement List)**
54+
- Year/Month of statement
55+
- Total amount for the statement
56+
- Navigate with ``/`` keys
57+
58+
**Right Panel (Transaction Details)**
59+
- Transaction date
60+
- Amount with currency
61+
- Description (normalized)
62+
- Location (if available)
63+
- Navigate with ``/`` keys
64+
- Sort with `s` key
65+
2166
## Installation
2267

2368
### Option 1: Build with Go
@@ -96,51 +141,6 @@ nix build .#statements-windows-amd64
96141

97142
All builds will be available in the `result/bin/` directory after building.
98143

99-
## Usage
100-
101-
```bash
102-
./statements <path-to-statement-list.json>
103-
```
104-
105-
## Keyboard Controls
106-
107-
### All Views
108-
- `Tab` - Switch between Summary and Statements views
109-
- `q` or `Ctrl+C` - Quit the application
110-
111-
### Statements View
112-
- `` or `k` - Select previous statement
113-
- `` or `j` - Select next statement
114-
- `` or `h` - Navigate to previous transaction
115-
- `` or `l` - Navigate to next transaction
116-
- `s` - Cycle through sort modes (Date → Amount → Location)
117-
118-
## Views
119-
120-
### Summary View
121-
Displays an overview of all transactions:
122-
- Total number of statements
123-
- Transaction counts by category
124-
- Apple Pay breakdown by card (last 4 digits)
125-
- PayPal transaction summary
126-
- Foreign transaction fee summary
127-
128-
### Statements View
129-
Browse statements with two panels:
130-
131-
**Left Panel (Statement List)**
132-
- Year/Month of statement
133-
- Total amount for the statement
134-
- Navigate with ``/`` keys
135-
136-
**Right Panel (Transaction Details)**
137-
- Transaction date
138-
- Amount with currency
139-
- Description (normalized)
140-
- Location (if available)
141-
- Navigate with ``/`` keys
142-
- Sort with `s` key
143-
144144
## Project Structure
145145

146146
```

0 commit comments

Comments
 (0)