docs: refresh README (architecture, badges, setup)#2
Merged
Conversation
- Rename Readme.md -> README.md - Add license/stack badges and mermaid architecture diagram (clients -> Express/Socket.io -> MongoDB + S3/Bunny/Stripe/OAuth) - Document env vars (names only), scripts, project structure, PM2 deploy - Link API_ROUTES.md with staleness caveat Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Bugbot is not enabled for your account, so this pull request was not reviewed. Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs. |
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.
Rewrites the README grounded in the actual codebase:
Readme.md→README.md(GitHub convention; case-only rename via git mv).env.example→.env, env var table built from grepping everyprocess.envreference (28 vars; names + purpose only)Noted while researching (not in this PR):
.env.exampleis missingOPENROUTER_API_KEY,OPENAI_API_KEY,BOTCHAT_USE_ELIZA;API_ROUTES.mdis partially stale.🤖 Generated with Claude Code