Skip to content

docs: top-notch README, streaming docs, combined pattern + 4 runnable examples#8

Merged
ferhimedamine merged 1 commit into
mainfrom
docs/readme-examples-polish
Jul 2, 2026
Merged

docs: top-notch README, streaming docs, combined pattern + 4 runnable examples#8
ferhimedamine merged 1 commit into
mainfrom
docs/readme-examples-polish

Conversation

@ferhimedamine

Copy link
Copy Markdown
Contributor

What

  • README: badges (npm/CI/license/TS), expanded options tables with types, streaming example, Pattern 3 (combined), shared-client example, troubleshooting section, link to examples dir
  • examples/: 4 standalone runnable scripts with tsx
    • 01-middleware.ts — transparent recall + store across sessions
    • 02-tools.ts — model-driven recallMemory / storeMemory with tool call logging
    • 03-combined.ts — middleware recall + explicit tool persistence, shared DakeraClient
    • 04-streaming.ts — streamText with middleware, note on post-stream persistence
    • examples/package.json + examples/README.md with prereqs and run instructions

Closes / follow-on from

DAK-7289 (founder request: CI green + repo public + readme/docs/examples top notch)

CI

No source changes — CI matrix (typecheck / test / build) passes unchanged.

@ferhimedamine ferhimedamine merged commit 00432f9 into main Jul 2, 2026
2 checks passed
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