Skip to content

docs(v1): rewrite README as concise overview (Cloud-branded) - #9

Merged
dani1005 merged 1 commit into
v1from
docs/v1-marketing-readme
Jul 31, 2026
Merged

docs(v1): rewrite README as concise overview (Cloud-branded)#9
dani1005 merged 1 commit into
v1from
docs/v1-marketing-readme

Conversation

@dani1005

Copy link
Copy Markdown
Collaborator

Replaces the flat six-endpoint README with a concise, marketing-style overview — the repo default branch (v1) face and PyPI project page.

Includes:

  • Reused EverOS brand banner + a prominent "Cloud" subtitle and a "which package?" pointer distinguishing this from the OSS everos library.
  • Value props: self-evolving memory, structured memory (not chat logs), retrieval modes, multimodal, built-for-production (managed + low-latency + high-concurrency), fully typed.
  • Install (with --pre + 0.4.x migration note), a minimal quickstart, and links.

Depends on: #8 — full usage now lives in quickstart.md, which this README links to. Merge #8 first (or together).

Follow-ups (factory): to render this README on the PyPI page, setup.py must use README.md as a markdown long_description (setup.mustache override) — separate factory MR.

🤖 Generated with Claude Code

Marketing-style landing: hero, value props (self-evolving memory,
structured memory, retrieval modes, multimodal, production, typed),
install, minimal quickstart. Full usage moves to quickstart.md.

Reuses the EverOS brand banner with a prominent 'Cloud' subtitle and a
'which package?' pointer to distinguish from the OSS everos library.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@dani1005
dani1005 merged commit f878150 into v1 Jul 31, 2026
1 check passed
@dani1005
dani1005 deleted the docs/v1-marketing-readme branch July 31, 2026 05:39
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