docs: public-ready README, thumbnail, and accurate license#19
Merged
Conversation
The repo is now public under the Hightecc org. Drop the private app.hejmly.com domain, document the recipes app, fix MCP tool names to the real double-underscore form, correct the Elastic License 2.0 description, remove the stale pre-v0 warning (now v0.0.1), strip em dashes, and add a screenshot plus a short feature list. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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
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
The repo is now public under the Hightecc org, but the README still read like a private internal doc. This makes it public-ready: it stops pointing at the private production domain, tells the truth about what is actually built, fixes the license description, and presents the project with a screenshot and a short feature list.
What changed and why
<your-domain>placeholder, so the public README does not hardcode the live deployment.grocery.list_items) to the real double-underscore names (grocery__list_items,recipes__list, and so on), which is what the code registers.docs/thumbnail.png) and a short feature list under the title.How to verify
Not in this PR
.env.examplestill has 4 app.hejmly.com references; the Caddyfile keeps the domain only as a parameterized default. Both can be a follow-up if wanted.