Skip to content

docs(readme): write an introduction to the repo - #29

Merged
catinspace-au merged 3 commits into
mainfrom
docs/readme-human
Nov 13, 2026
Merged

catinspace-au merged 3 commits into
mainfrom
docs/readme-human

Conversation

@catinspace-au

Copy link
Copy Markdown
Contributor

The README explains what the reducer does, installation, CLI and library quick starts, the pipeline and mode and level tables in about 900 words. Sampling, target collection, memory, sources and sinks, embedding, configuration and logging moved unchanged to docs/library-guide.md. The working guide moved to CONTRIBUTING.md. The package description matches the GitHub description.

The README explains what the reducer does, installation, CLI and library quick starts, the pipeline and mode and level tables in about 900 words. Sampling, target collection, memory, sources and sinks, embedding, configuration and logging moved unchanged to docs/library-guide.md. The working guide moved to CONTRIBUTING.md. The package description matches the GitHub description.
…claim

The bullet and table now say temporal mode ranks one candidate per template and window and returns up to max_patterns. The max_clusters note says a lower value cuts the work per line. It drops the square-law claim because the code does not support it.
semantic-release writes VERSION, the changelog and the tag from the commit type. It overwrites hand edits.
@catinspace-au
catinspace-au merged commit 032d6b2 into main Nov 13, 2026
17 checks passed
@catinspace-au
catinspace-au deleted the docs/readme-human branch November 13, 2026 03:42
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.

1 participant