Commit Graph

2 Commits

Author SHA1 Message Date
kayjaydee 2b23d87c80 docs: update README.md for clarity and structure
- Simplified project description and improved readability.
- Changed section titles for better organization (e.g., "Showcase" to "Demo").
- Reformatted screenshots into a markdown table for a cleaner layout.
- Enhanced the "What Does It Do?" section to clearly outline features.
- Streamlined the Quick Start and Commands sections for easier navigation.
2026-04-24 18:11:02 +02:00
kayjaydee 24ee43b3a3 docs: replace SHOWCASE.md with comprehensive README.md
- Replace portfolio-only SHOWCASE with unified README as sole project entry page
- Add full user guide: commands table, wand flow, region anatomy (all 15 config fields sourced from GravityFlipRegion.CODEC), visual modes, regions.json path
- Add developer section: prerequisites (JDK 25, Hytale API), project structure, build/test/deploy commands, extension snippets
- Add architecture overview with ASCII diagram (tick loop, wand flow, persistence)
- Correct subcommand list (wand/define/list/delete/toggle/tp) to match GravityFlipCommand source
- Preserve showcase content: video placeholder, screenshot grid (HTML table), 12 showcase regions table, feature list
- Add shields.io badges, tech-stack, roadmap, credits, license sections
2026-04-24 17:35:14 +02:00