Skip to content

docs: simplify README for npm install#339

Merged
cafitac merged 2 commits into
mainfrom
docs/simplify-readme-npm-install
May 14, 2026
Merged

docs: simplify README for npm install#339
cafitac merged 2 commits into
mainfrom
docs/simplify-readme-npm-install

Conversation

@cafitac

@cafitac cafitac commented May 14, 2026

Copy link
Copy Markdown
Owner

Summary

  • Replace the long operator-heavy README with a short OSS-facing README.
  • Keep the npm global install path as the primary setup path.
  • Keep only a minimal one-shot npm usage example, a basic memory example, Hermes note, local-first privacy note, and links to deeper docs.

Verification

  • git diff --check
  • npm exec --yes --package @cafitac/agent-memory@0.1.155 -- agent-memory doctor

@cafitac cafitac merged commit 44e5935 into main May 14, 2026
2 checks passed
@cafitac cafitac deleted the docs/simplify-readme-npm-install branch May 14, 2026 01:44
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