Skip to content

docs(readme): simplify intro, drop quants/ML-engineer framing#106

Merged
helloiamvu merged 1 commit into
mainfrom
claude/github-intro-simplify-7b7560
Jul 8, 2026
Merged

docs(readme): simplify intro, drop quants/ML-engineer framing#106
helloiamvu merged 1 commit into
mainfrom
claude/github-intro-simplify-7b7560

Conversation

@helloiamvu

Copy link
Copy Markdown
Member

Summary

  • Replace the long intro paragraph (README line 13) with a two-sentence version: what the SDK is, what ships today (weather + prediction-market settlements), and the local-first / no-API-key point.
  • Simplify the bold tagline (line 3) from "The public-data SDK for quants, ML pipelines, and AI agents." to "A Python + TypeScript SDK for public data."
  • Drops the "quants, ML engineers" audience framing everywhere, plus the exhaustive adapter lists and the "Next: SEC filings (EDGAR)..." roadmap sentence.

Docs-only change — no code, no public API surface (TS Parity: N/A).

Test plan

  • Verify greps: "quants, ML" and "SEC filings (EDGAR)" no longer appear in README.md; new intro strings present.
  • Pre-push hooks (full TS workspace test + typecheck) passed locally.

🤖 Generated with Claude Code

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown

Parity ticket gate: PASSED

parity-ticket-check: PR does not touch parity-trigger surface; gate skipped.

See CROSS-SDK-SYNC.md §2 for the workflow.

@helloiamvu helloiamvu merged commit c93c7e7 into main Jul 8, 2026
11 checks passed
@helloiamvu helloiamvu deleted the claude/github-intro-simplify-7b7560 branch July 8, 2026 12:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants