Commit 87b6bf0
docs(readme): replace How-It-Works diagram with the actual data flow
The old how-it-works.svg was a PROBLEM/SOLUTION before/after diagram —
it showed the value prop, not the mechanism, and duplicated the Why
section. Replace it with a flow that depicts the real mental model:
any Filing -> .obj() -> the typed object built for that form
(TenK, TenQ, Form4, ThirteenF, FundReport), each with its data payload.
Trim prose P1 to a one-line framing (the diagram now carries the
per-form list) and move it above the pipeline/AI paragraph so the
section reads: model -> diagram -> integration, with the runnable
version in Quick Start just below.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>1 parent cd167cd commit 87b6bf0
2 files changed
Lines changed: 102 additions & 86 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
59 | 59 | | |
60 | 60 | | |
61 | 61 | | |
62 | | - | |
63 | | - | |
64 | | - | |
| 62 | + | |
65 | 63 | | |
66 | 64 | | |
67 | | - | |
| 65 | + | |
68 | 66 | | |
69 | 67 | | |
| 68 | + | |
| 69 | + | |
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
| |||
Loading
0 commit comments