docs: rewrite README as end-user documentation - #21
Merged
Merged
Conversation
Drag the README back to an end-user pitch: remove coder narration (module format internals, dependency/roadmap notes) and present the tool in plain language for financial-data users and AI readers. Removes em dashes. Add a patch changeset.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Drags the README back to an end-user pitch. The recent streaming/Parquet/CLI leaps had let the README drift into narration of the coder (module-format internals, dependency and roadmap notes like the "foot in the door" line). This rewrite:
Changes
README.md: end-user rewrite; no coder narration; no em dashes..changeset/fuzzy-readmes-resample.md: new patch changeset.Docs-only change; no test impact.