Skip to content

Commit a70e284

Browse files
committed
✨ feat: display dynamic package version in sidebar
1 parent 49a92f2 commit a70e284

3 files changed

Lines changed: 47 additions & 39 deletions

File tree

README.md

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -18,38 +18,44 @@ A terminal-based zero-based budgeting application inspired by YNAB. Every dollar
1818
## Features
1919

2020
### Core Budgeting
21+
2122
- **Zero-based budgeting** - Assign every dollar to a category before you spend it
2223
- **Budget targets** - Set recurring targets (weekly, monthly, yearly, or by specific date) with auto-fill
2324
- **Fund movement** - Move money between categories as priorities change
2425
- **Rollover support** - Carry over surplus or deficit from previous periods
2526
- **Overspending alerts** - Track and resolve overspent categories
2627

2728
### Account Management
29+
2830
- **Multiple account types** - Checking, savings, credit cards, cash, investments, lines of credit
2931
- **On/off-budget accounts** - Track investment accounts without affecting your budget
3032
- **Account archiving** - Hide accounts without losing historical data
3133
- **Net worth tracking** - See your complete financial picture
3234

3335
### Transaction Management
36+
3437
- **Full transaction tracking** - Date, payee, category, memo, and cleared status
3538
- **CSV import** - Import transactions from your bank
3639
- **Transfers** - Move money between accounts with linked transactions
3740
- **Bulk operations** - Categorize multiple transactions at once
3841
- **Reconciliation** - Match your records with bank statements
3942

4043
### Reporting
44+
4145
- **Budget overview** - See budgeted, spent, and available by category
4246
- **Spending analysis** - Track spending by category with percentage breakdowns
4347
- **Account register** - Filter transactions by date, payee, or category
4448
- **Net worth report** - Assets vs liabilities summary
4549

4650
### Data & Security
51+
4752
- **Local-first storage** - All data stored on your machine in JSON format
4853
- **AES-256-GCM encryption** - Optional passphrase-protected encryption with Argon2 key derivation
4954
- **Automatic backups** - Configurable backup retention
5055
- **Multi-format export** - CSV, JSON, or YAML for portability
5156

5257
### Interface
58+
5359
- **Interactive TUI** - Full terminal interface with vim-style navigation
5460
- **CLI commands** - Script-friendly command-line interface for automation
5561
- **Command palette** - Quick access to all actions with `:` key
@@ -112,7 +118,7 @@ envelope tui
112118

113119
```bash
114120
envelope account create "Savings" --type savings --balance 5000.00
115-
envelope account create "Visa" --type credit --balance -1200.00
121+
envelope account create "Visa" --type credit --balance 1200.00
116122
envelope account list # Show all active accounts
117123
envelope account list --all # Include archived accounts
118124
envelope account show "Checking" # View account details
@@ -226,56 +232,56 @@ envelope --help # Show all commands
226232

227233
### Global
228234

229-
| Key | Action |
230-
|-----|--------|
231-
| `q` | Quit |
232-
| `?` | Help dialog |
233-
| `:` | Command palette |
234-
| `Tab` | Switch panel focus |
235+
| Key | Action |
236+
| ----- | ------------------------ |
237+
| `q` | Quit |
238+
| `?` | Help dialog |
239+
| `:` | Command palette |
240+
| `Tab` | Switch panel focus |
235241
| `h/l` | Focus sidebar/main panel |
236-
| `j/k` | Navigate down/up |
237-
| `1` | Accounts view |
238-
| `2` | Budget view |
239-
| `3` | Reports view |
242+
| `j/k` | Navigate down/up |
243+
| `1` | Accounts view |
244+
| `2` | Budget view |
245+
| `3` | Reports view |
240246

241247
### Register View (Transactions)
242248

243-
| Key | Action |
244-
|-----|--------|
245-
| `a` | Add transaction |
246-
| `e` | Edit selected transaction |
247-
| `c` | Toggle cleared status |
248-
| `Ctrl+d` | Delete transaction |
249-
| `v` | Multi-select mode |
250-
| `Space` | Toggle selection (in multi-select) |
251-
| `g` | Go to top |
252-
| `G` | Go to bottom |
249+
| Key | Action |
250+
| -------- | ---------------------------------- |
251+
| `a` | Add transaction |
252+
| `e` | Edit selected transaction |
253+
| `c` | Toggle cleared status |
254+
| `Ctrl+d` | Delete transaction |
255+
| `v` | Multi-select mode |
256+
| `Space` | Toggle selection (in multi-select) |
257+
| `g` | Go to top |
258+
| `G` | Go to bottom |
253259

254260
### Budget View
255261

256-
| Key | Action |
257-
|-----|--------|
258-
| `[` / `]` | Previous/next period |
259-
| `m` | Move funds between categories |
260-
| `a` | Add category |
261-
| `A` | Add category group |
262-
| `Enter` | Edit budget/target for category |
262+
| Key | Action |
263+
| --------- | ------------------------------- |
264+
| `[` / `]` | Previous/next period |
265+
| `m` | Move funds between categories |
266+
| `a` | Add category |
267+
| `A` | Add category group |
268+
| `Enter` | Edit budget/target for category |
263269

264270
### Sidebar
265271

266-
| Key | Action |
267-
|-----|--------|
268-
| `a` | Add account |
269-
| `Enter` | Select account |
270-
| `A` | Toggle archived accounts |
272+
| Key | Action |
273+
| ------- | ------------------------ |
274+
| `a` | Add account |
275+
| `Enter` | Select account |
276+
| `A` | Toggle archived accounts |
271277

272278
### Dialogs
273279

274-
| Key | Action |
275-
|-----|--------|
276-
| `Esc` | Close/cancel |
277-
| `Enter` | Confirm |
278-
| `Tab` | Next field |
280+
| Key | Action |
281+
| ------- | ------------ |
282+
| `Esc` | Close/cancel |
283+
| `Enter` | Confirm |
284+
| `Tab` | Next field |
279285

280286
## Data Storage
281287

RELEASING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ name = "envelope-cli"
3434
version = "X.Y.Z" # Update this
3535
```
3636

37+
> **Note:** The TUI sidebar version display uses `env!("CARGO_PKG_VERSION")` at compile time, so updating `Cargo.toml` automatically updates the version shown in the UI. No manual changes needed elsewhere.
38+
3739
Commit the version bump:
3840

3941
```bash

src/tui/views/sidebar.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ fn render_header(frame: &mut Frame, area: Rect) {
4040
.borders(Borders::ALL)
4141
.border_style(Style::default().fg(Color::White));
4242

43-
let version = Paragraph::new("v0.1.0")
43+
let version = Paragraph::new(format!("v{}", env!("CARGO_PKG_VERSION")))
4444
.block(block)
4545
.style(Style::default().fg(Color::Yellow));
4646

0 commit comments

Comments
 (0)