Skip to content

Commit 87b6bf0

Browse files
dgunningclaude
andcommitted
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

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ Company("AAPL").get_financials().income_statement()
5959

6060
## How It Works
6161

62-
Everything starts with a **`Company`** or a **`Filing`**. Ask a company for its filings, or pull filings directly by form type — then call **`.obj()`** and you get a typed object built for that form: a `TenK` knows risk factors and MD&A, a `Form4` knows insider transactions, a `ThirteenF` knows holdings. Financials come straight from XBRL, standardized for cross-company comparison, and everything hands back pandas DataFrames.
63-
64-
The same typed output that reads cleanly in a notebook drops straight into a pipeline: DataFrames for your warehouse, LLM-ready text and an MCP server for your AI stack, rate-limit and enterprise-mirror aware for scale.
62+
Everything starts with a **`Company`** or a **`Filing`**. Call **`.obj()`** and you get a typed object built for that form — its data ready as pandas DataFrames and clean text.
6563

6664
<p align="center">
67-
<img src="https://raw.githubusercontent.com/dgunning/edgartools/main/docs/images/how-it-works.svg" alt="How EdgarTools Python library extracts SEC EDGAR filing data">
65+
<img src="https://raw.githubusercontent.com/dgunning/edgartools/main/docs/images/how-it-works.svg" alt="How EdgarTools turns any SEC filing into a typed Python object">
6866
</p>
6967

68+
The same typed output that reads cleanly in a notebook drops straight into a pipeline: DataFrames for your warehouse, LLM-ready text and an MCP server for your AI stack, rate-limit and enterprise-mirror aware for scale.
69+
7070
<p align="center">
7171
<img src="https://raw.githubusercontent.com/dgunning/edgartools/main/docs/images/sections/section-quick-start.svg" alt="Quick Start">
7272
</p>

docs/images/how-it-works.svg

Lines changed: 98 additions & 82 deletions
Loading

0 commit comments

Comments
 (0)