Skip to content

docs: comprehensive README update#426

Open
xkonjin wants to merge 1 commit intoamilich:mainfrom
xkonjin:docs/update-readme
Open

docs: comprehensive README update#426
xkonjin wants to merge 1 commit intoamilich:mainfrom
xkonjin:docs/update-readme

Conversation

@xkonjin
Copy link

@xkonjin xkonjin commented Feb 17, 2026

Added detailed project documentation with architecture diagrams, installation guide, and usage examples.


Note

Low Risk
Documentation-only changes; no runtime code or behavior is modified.

Overview
Expands README.md from a short overview into a full project guide, adding live-demo badges/links and much more detailed feature descriptions for both IsoCity and IsoCoaster.

Adds documentation for the tech stack, a Mermaid architecture diagram, repository structure, step-by-step install/build/lint commands, a usage walkthrough (including multiplayer), environment variable reference, contributing guidelines, acknowledgments, and a links section.

Written by Cursor Bugbot for commit fdb74be. This will update automatically on new commits. Configure here.

@assert-app
Copy link

assert-app bot commented Feb 17, 2026

Your pull request is now ready for review with Assert.

Open Review →


Stop waiting for your code to break. Ship with confidence using Assert.

@vercel
Copy link
Contributor

vercel bot commented Feb 17, 2026

Someone is attempting to deploy a commit to the andrew-4640's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

# Optional: Enable multiplayer features
NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
NEXT_PUBLIC_SUPABASE_ANON_KEY=your_supabase_anon_key
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Public GT API key documented

High Severity · Security Issue

The Environment Variables section documents NEXT_PUBLIC_GT_API_KEY / NEXT_PUBLIC_GT_PROJECT_ID for gt-next. In Next.js, the NEXT_PUBLIC_ prefix exposes values to the browser bundle, which can leak the translation API key. It also appears inconsistent with typical gt-next configuration, making setup confusing and potentially unsafe.

Fix in Cursor Fix in Web

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