Skip to content

Commit b9ca16f

Browse files
dgunningclaude
andcommitted
docs(readme): strip Key Features to a tight 4-group inventory
The section had grown to 7 groups / ~40 bullets and mostly restated the 3-pillar grid and Use Cases (financials, funds, insiders, reliability, DX). Cut to 4 groups / ~16 bullets that keep only the distinguishing, search-worthy specifics an evaluator scans for — dimensional XBRL, Company Facts time-series, EX-21 subsidiaries, N-MFP/N-CSR, enterprise mirrors, full-text search. Drop generic table-stakes bullets and the redundant "Comprehensive SEC Data Access" subheading (the section image already reads "Key Features"). Keep the form-types paragraph as the deliberate SEO anchor. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 87b6bf0 commit b9ca16f

1 file changed

Lines changed: 17 additions & 51 deletions

File tree

README.md

Lines changed: 17 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -152,67 +152,33 @@ facts.query().by_concept("Revenue").to_dataframe() # Revenue history as DataFra
152152
<img src="https://raw.githubusercontent.com/dgunning/edgartools/main/docs/images/sections/section-features.svg" alt="Key Features">
153153
</p>
154154

155-
### Comprehensive SEC Data Access
156-
157155
<table>
158156
<tr>
159157
<td width="50%" valign="top">
160158

161-
**Financial Statements (XBRL)**
162-
- Balance Sheets, Income Statements, Cash Flows
163-
- Individual line items via XBRL tags
164-
- Multi-period comparisons with comparative periods
165-
- Standardized cross-company data
166-
- Automatic unit conversion
167-
- Metadata columns (dimensions, members, units)
168-
- Complete dimensional data support
169-
170-
**Fund & Investment Data**
171-
- 13F institutional holdings & portfolio analysis
172-
- N-PORT fund portfolio data
173-
- N-MFP money market fund holdings
174-
- N-CSR/N-CEN fund reports
175-
- Position tracking over time
176-
177-
**Company Dataset & Reference Data**
178-
- Industry and state filtering
179-
- Company subsets with metadata
180-
- Standardized industry classifications
181-
- SEC ticker/CIK lookups
182-
- Exchange information
159+
**Financial data**
160+
- Income, balance sheet, cash flow — XBRL-standardized for cross-company comparison
161+
- Individual line items, dimensional data, multi-period comparatives
162+
- Company Facts API: time-series for any concept across years
183163

184-
**Insider Transactions**
185-
- Form 3, 4, 5 structured data
186-
- Transaction history by insider
187-
- Ownership changes
188-
- Grant and exercise details
189-
- Automatic parsing
164+
**Funds & ownership**
165+
- 13F holdings, N-PORT, N-MFP, N-CSR/N-CEN fund reports
166+
- Form 3/4/5 insider transactions; Schedule 13D/G ownership
167+
- Position tracking over time
190168

191169
</td>
192170
<td width="50%" valign="top">
193171

194-
**Filing Intelligence**
195-
- Any form type (10-K, 10-Q, 8-K, S-1, etc.)
196-
- Complete history since 1994
197-
- Typed data objects for 20+ form types
198-
- HTML to clean text extraction
199-
- Section extraction (Risk Factors, MD&A)
200-
- Subsidiaries (EX-21) and auditor extraction
201-
202-
**Performance & Reliability**
203-
- Configurable rate limiting (enterprise mirrors supported)
204-
- Custom SEC data sources (corporate/academic mirrors)
205-
- Smart caching (30-second fresh filing cache)
206-
- Robust error handling
207-
- SSL verification with fail-fast retry
208-
- Type hints throughout
209-
- [Enterprise configuration →](docs/configuration.md#enterprise-configuration)
172+
**Filings & text**
173+
- Typed objects for 20+ forms; complete history since 1994
174+
- Section extraction (Risk Factors, MD&A), EX-21 subsidiaries, auditor info
175+
- HTML → clean text + markdown for RAG; full-text search
176+
- Ticker/CIK lookup, industry & exchange filtering
210177

211-
**Developer Experience**
212-
- Intuitive, consistent API
213-
- Pandas DataFrame integration
214-
- Rich terminal output
215-
- 1000+ tests
178+
**Built for production**
179+
- Configurable rate limiting + enterprise/academic mirrors
180+
- Smart caching, type hints throughout, 1000+ tests
181+
- [Enterprise configuration →](docs/configuration.md#enterprise-configuration)
216182

217183
</td>
218184
</tr>

0 commit comments

Comments
 (0)