Skip to content

docs: professional README — problem, solution, all commands documented#3

Merged
vamsivarma27 merged 1 commit intomainfrom
docs/readme-overhaul
Apr 6, 2026
Merged

docs: professional README — problem, solution, all commands documented#3
vamsivarma27 merged 1 commit intomainfrom
docs/readme-overhaul

Conversation

@vamsivarma27
Copy link
Copy Markdown
Owner

Summary

Complete README overhaul. Goes from a basic usage file to a proper open source README that explains the full story.

What's in this README

  • Badges — SkillsMP approved, version, MIT license, Agent Skills compatible, PRs welcome
  • The Problem — explains UI lock-in clearly with real code examples showing what AI does wrong
  • The Solution — before/after table showing exactly what changes vs what never changes
  • Install — all 4 install methods (openskills, agent-skills-cli, manual project, manual global)
  • Every command documented individually with its own section, explanation, and examples:
    • /ui-restructure — base command
    • --style — table with description + best use case per style
    • --mode — table showing what changes vs stays for each mode
    • --god-mode — full explanation of 100-user mindset, friction audit, 6 UX principles
    • --keep-tokens — when and why
    • --remove-tokens — difference from default
    • --grid — column breakdown by screen size
    • --density — spacing multiplier explained
    • --prompt — 3 real-world examples
  • Combined examples — 5 real command combos
  • What gets changed vs preserved — full table
  • Framework + AI tool support — compatibility tables with install paths per tool
  • Skill structure — visual tree with inline descriptions
  • The polish standard — what every restructure guarantees
  • Contributing + License

Test plan

  • Preview README renders correctly on GitHub
  • All badge URLs resolve
  • Install commands are correct

🤖 Generated with Claude Code

…lly documented

- Problem section: explains UI lock-in clearly with code examples
- Solution: before/after table of what changes vs stays
- Every command documented individually with its own section
- Style engines table with description + best use case
- Mode table showing exactly what changes vs stays
- God Mode fully explained (100-user mindset, friction audit, 6 UX principles)
- Combined examples section
- Framework + AI tool compatibility tables with install paths
- Skill structure tree with descriptions
- Polish standard section
- Badges: SkillsMP, version, MIT, Agent Skills, PRs Welcome

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vamsivarma27 vamsivarma27 merged commit f90214f into main Apr 6, 2026
1 check failed
@vamsivarma27 vamsivarma27 deleted the docs/readme-overhaul branch April 6, 2026 15:44
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