docs: rewrite README for clarity, positioning, and growth#190
Merged
Conversation
Restructure the README to lead with the problem LLMKube solves rather than a feature list. Elevate the Metal Agent architecture into a dedicated hero section — it's the key differentiator no other K8s LLM tool offers. Add an honest comparison table against vLLM, Ollama, KServe, and LocalAI. Compress quickstart, move detailed setup guides to linked docs, and cut overall length from ~760 to ~280 lines. Remove claims about unsupported hardware (AMD/Intel GPUs). Signed-off-by: Christopher Maher <chris@mahercode.io>
7b3c131 to
6e3a088
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Motivation
The current README lists features but doesn't immediately communicate why LLMKube exists or what makes it different. The Metal Agent — running native processes outside containers but orchestrated by K8s CRDs — is genuinely novel and deserves to be the hero story. The comparison table gives visitors an honest picture of where LLMKube fits relative to alternatives.
Test plan