Description
The project has grown into a small in-Editor runtime inspection and experimentation tool. The README should emphasize the user workflow more than implementation history or phase-by-phase details.
The current README is already useful, but 0.8.2 is a good point to tighten the narrative around the main loop:
- Search or inspect a live object.
- Pin or bind it to
_.
- Watch values that should keep updating.
- Insert generated access code into the editor.
- Validate before running risky code.
- Patch a method temporarily when runtime behavior needs to change.
Why
Users coming from OpenUPM or GitHub want to quickly understand what problem the tool solves. Too much implementation detail can make the tool look more complex than it feels in use.
Suggested Fix
Restructure or lightly edit README sections so the first half is workflow-first:
- What it does.
- Install.
- Quick start.
- Core workflow.
- Feature guide.
- Safety/data handling.
- Troubleshooting.
- Menus/reference.
Keep implementation-heavy notes in CHANGELOG or lower README sections.
Acceptance Criteria
Description
The project has grown into a small in-Editor runtime inspection and experimentation tool. The README should emphasize the user workflow more than implementation history or phase-by-phase details.
The current README is already useful, but 0.8.2 is a good point to tighten the narrative around the main loop:
_.Why
Users coming from OpenUPM or GitHub want to quickly understand what problem the tool solves. Too much implementation detail can make the tool look more complex than it feels in use.
Suggested Fix
Restructure or lightly edit README sections so the first half is workflow-first:
Keep implementation-heavy notes in CHANGELOG or lower README sections.
Acceptance Criteria