Skip to content

docs: rewrite README as end-user documentation #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adiled merged 5 commits into from
Aug 27, 2026
Merged

docs: rewrite README as end-user documentation #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3995ee4
docs: rewrite README as end-user documentation
adiled Aug 27, 2026
2b65e05
docs: add npx quick-start option and fold install one-liner into quic…
adiled Aug 27, 2026
db99463
docs: note arbitrary input schemas via map in supported formats
adiled Aug 27, 2026
60db0c7
docs: reframe map as feed-data-as-is; condense README and cut repetition
adiled Aug 27, 2026
763203b
docs: note Parquet pipe input is file-only
adiled Aug 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .changeset/fuzzy-readmes-resample.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
---
"ohlc-resample": patch
---

Rewrite the README as end-user documentation: drop internal implementation
narration (module-format internals, dependency and roadmap notes) and present
the tool in plain language for financial-data users. Also removes em dashes
for easier machine parsing.
Loading
Loading