Skip to content

feat: rewrite README to align with new website messaging#366

Merged
BYK merged 1 commit into
mainfrom
feat/readme-rewrite
May 16, 2026
Merged

feat: rewrite README to align with new website messaging#366
BYK merged 1 commit into
mainfrom
feat/readme-rewrite

Conversation

@BYK
Copy link
Copy Markdown
Owner

@BYK BYK commented May 16, 2026

Summary

Rewrites the README to align with the new website messaging while preserving the project's technical depth and research roots.

Key changes

Messaging alignment:

  • Opens with pain + solution ("Stop re-explaining your project to your AI") instead of architecture
  • Adds the unified pipeline angle: context management and memory are the same problem, not two separate tools
  • "Why" section now explains the gap between memory-only and context-only approaches

New sections:

  • What to expect — rewritten with user-facing benefits: infinite sessions, cost savings, decisions that stick, conversation import, any-provider compatibility, team knowledge via Lore Cloud
  • Quick Startlore run as the primary entry point, with OpenCode/Pi plugin setup as alternatives
  • Cost efficiency — batch APIs (50% off), cheaper worker models, predictive cache warming, 3-block system prompt caching, compaction elimination, content deduplication
  • lore import — documents conversation import from 7 agents (Claude Code, Codex, Aider, Cline, Continue, OpenCode, Pi)

Fixes:

  • All AGENTS.md references → .lore.md
  • All DEVELOPMENT_CONTEXT.md references removed
  • Configuration example updated (agentsFile path → .lore.md)
  • License confirmed as FSL-1.1-Apache-2.0

Preserved:

  • Full research credits in "Standing on the shoulders of"
  • Complete benchmark tables and methodology
  • "How we got here" project history (v1→v4)
  • Technical depth: three-tier architecture, gradient context manager, recall tool, CLI reference, lat.md compatibility
  • Configuration reference with all options

- Lead with pain + solution, not architecture
- Add unified pipeline angle (context + memory = one problem)
- Add cost efficiency section (batch APIs, cache warming, worker models)
- Add conversation import, any-provider, vector search, team knowledge
- Fix .lore.md references (was AGENTS.md)
- Add Quick Start with `lore run` as primary entry point
- Remove DEVELOPMENT_CONTEXT.md references
- Keep full research credits, benchmarks, and technical depth
- Keep How we got here section preserving project history
@BYK BYK force-pushed the feat/readme-rewrite branch from 02f608f to 8344f0d Compare May 16, 2026 20:20
@BYK BYK merged commit 6057681 into main May 16, 2026
7 checks passed
@BYK BYK deleted the feat/readme-rewrite branch May 16, 2026 20:23
@craft-deployer craft-deployer Bot mentioned this pull request May 16, 2026
6 tasks
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