Skip to content

docs: add Docker Compose quick start to README - #60

Merged
starboyate merged 1 commit into
mainfrom
chore/update-readme
May 11, 2026
Merged

starboyate merged 1 commit into
mainfrom
chore/update-readme

Conversation

@me0106

@me0106 me0106 commented May 11, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Move Docker Compose to the front of the README as the default quick start path.
  • Add Docker startup instructions for memind-server and memind-ui, including ports, health check, logs, shutdown,
    and persisted data volume.
  • Clarify that OPENAI_API_KEY is required, while OPENAI_BASE_URL, OPENAI_CHAT_MODEL, and
    OPENAI_EMBEDDING_MODEL are optional, and that chat/embedding model choices affect Memory quality.
  • Keep the original Java quickstart and embedding instructions as the source-based path.

Test Plan

  • Ran git diff --check -- README.md README_zh.md
  • Verified README and README_zh content structure manually

Notes

This is a documentation-only change. No runtime code was changed.

@starboyate
starboyate merged commit ce06839 into main May 11, 2026
2 checks passed
@starboyate
starboyate deleted the chore/update-readme branch May 14, 2026 06:03
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.

2 participants