Skip to content

docs: overhaul README with AI-first structure and 8 generated demo examples#2

Merged
Ne9roni merged 2 commits into
masterfrom
cursor/improve-readme-7122
Apr 19, 2026
Merged

docs: overhaul README with AI-first structure and 8 generated demo examples#2
Ne9roni merged 2 commits into
masterfrom
cursor/improve-readme-7122

Conversation

@Ne9roni
Copy link
Copy Markdown
Owner

@Ne9roni Ne9roni commented Apr 19, 2026

Summary

Restructures the README to lead with AI use cases and backs it up with real generated output.

Key changes

Structure reordering:

  • "AI Agent Integration" moved immediately after "Why piskel-cli?" — the AI workflow is now the second thing a reader sees, not buried near the bottom
  • New "AI-Generated Demo" section replaces the old "Demo" section, with an explicit callout that no image model was used

AI Agent Integration section (now #2):

  • Clear headline: "You don't need an image generation model"
  • Shows the exact npx skills add install command
  • Plain-language example: describe what you want → agent writes plan.json → piskel-cli run → done

AI-Generated Demo section:

  • 4 PNG sprites in a side-by-side table: Mushroom, Gem, Sword, Heart
  • 4 GIF animations in a side-by-side table: Coin Spin, Fire, Ghost, Twinkle Star
  • Each entry links directly to its plan file so readers can inspect or run it themselves

New example plan files (6 added):

  • examples/mushroom-plan.json — 16×16 red mushroom with white spots
  • examples/gem-plan.json — 16×16 purple faceted gem
  • examples/sword-plan.json — 16×16 diagonal sword with golden guard
  • examples/coin-spin-plan.json — 4-frame coin rotation animation
  • examples/fire-plan.json — 3-frame flickering fire animation
  • examples/ghost-plan.json — 4-frame floating ghost animation

All output files committed to examples-output/ so the demo images render directly on GitHub.

Open in Web Open in Cursor 

cursoragent and others added 2 commits April 19, 2026 13:54
Co-authored-by: Ne9roni <Ne9roni@users.noreply.github.com>
- Move AI Agent Integration section immediately after Why piskel-cli?
- Add AI-Generated Demo section with 4 PNG sprites and 4 GIF animations
- Add 6 new plan files: mushroom, gem, sword, coin-spin, fire, ghost
- Add corresponding generated output files as demo artifacts

Co-authored-by: Ne9roni <Ne9roni@users.noreply.github.com>
@cursor cursor Bot changed the title docs: overhaul README with professional structure and demo section docs: overhaul README with AI-first structure and 8 generated demo examples Apr 19, 2026
@Ne9roni Ne9roni merged commit c400722 into master Apr 19, 2026
1 check passed
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.

2 participants