lobo/zfin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

some readme cleanup

Browse source
This commit is contained in:
Emil Lerch 2026-03-01 12:11:40 -08:00
parent b510a86b09
commit 9d86ccf2e5
Signed by: lobo
GPG key ID: A7B62D657EF764F8
1 changed files with 52 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -122,7 +122,7 @@ Every data fetch follows the same pattern:
Cache files use [SRF](https://github.com/lobo/srf) (Simple Record Format), a line-oriented key-value format. Freshness is determined by file modification time vs. the TTL for that data type. Cache files use [SRF](https://github.com/lobo/srf) (Simple Record Format), a line-oriented key-value format. Freshness is determined by file modification time vs. the TTL for that data type.
| Data type | TTL | Rationale | | Data type | TTL | Rationale |
|---------------|--------------|-------------------------------------------------| |---------------|--------------|--------------------------------------------------|
| Daily candles | 24 hours | Only changes once per trading day | | Daily candles | 24 hours | Only changes once per trading day |
| Dividends | 7 days | Declared well in advance | | Dividends | 7 days | Declared well in advance |
| Splits | 7 days | Rare corporate events | | Splits | 7 days | Rare corporate events |
@ -211,11 +211,11 @@ zfin i --default-keys > ~/.config/zfin/keys.srf
Default keybindings: Default keybindings:
| Key | Action | | Key | Action |
|---|---| |------------------------|------------------------------------------------------|
| `q`, `Ctrl+c` | Quit | | `q`, `Ctrl+c` | Quit |
| `r`, `F5` | Refresh current tab (invalidates cache) | | `r`, `F5` | Refresh current tab (invalidates cache) |
| `R` | Reload portfolio from disk (no network) | | `R` | Reload portfolio from disk (no network) |
| `h`, Left | Previous tab | | `h`, Left, Shift+Tab | Previous tab |
| `l`, Right, Tab | Next tab | | `l`, Right, Tab | Next tab |
| `1`-`6` | Jump to tab | | `1`-`6` | Jump to tab |
| `j`, Down | Select next row | | `j`, Down | Select next row |
@ -427,14 +427,14 @@ account::HSA,tax_type::hsa
### Account fields ### Account fields
| Field | Type | Required | Description | | Field | Type | Required | Description |
|---|---|---|---| |------------|--------|----------|-----------------------------------------------------------------|
| `account` | string | Yes | Account name (must match `account::` in portfolio lots exactly) | | `account` | string | Yes | Account name (must match `account::` in portfolio lots exactly) |
| `tax_type` | string | Yes | Tax classification (see below) | | `tax_type` | string | Yes | Tax classification (see below) |
### Tax types ### Tax types
| Value | Display label | | Value | Display label |
|---|---| |---------------|-----------------------|
| `taxable` | Taxable | | `taxable` | Taxable |
| `roth` | Roth (Post-Tax) | | `roth` | Roth (Post-Tax) |
| `traditional` | Traditional (Pre-Tax) | | `traditional` | Traditional (Pre-Tax) |
@ -531,7 +531,7 @@ accounts.srf Account to tax type mapping for analysis
### Dependencies ### Dependencies
| Dependency | Source | Purpose | | Dependency | Source | Purpose |
|---|---|---| |----------------------------------------------------|---------------------|--------------------------------------------------|
| [SRF](https://github.com/lobo/srf) | Local (`../../srf`) | Cache file format and portfolio/watchlist parsing | | [SRF](https://github.com/lobo/srf) | Local (`../../srf`) | Cache file format and portfolio/watchlist parsing |
| [libvaxis](https://github.com/rockorager/libvaxis) | Git (v0.5.1) | Terminal UI rendering | | [libvaxis](https://github.com/rockorager/libvaxis) | Git (v0.5.1) | Terminal UI rendering |