chore: add assets directory to package.json and update demo image path in README

[truehazker]

Summary by CodeRabbit

• Documentation

  • Updated README image references from external URLs to local relative paths for improved asset management and accessibility.

• Chores

  • Assets directory now included in published package contents to ensure resources are distributed with releases.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates the README to reference a local demo image path instead of an external URL and adds the assets directory to the package.json files array for publication, ensuring the demo image is included when the package is distributed.

Changes

Cohort / File(s)	Summary
Documentation & Packaging Updates README.md, package.json	Updated demo image reference from external GitHub URL to local relative path ./assets/demo.gif; added assets to files array in package.json to include assets in published package distribution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A little hop, a path so near,
From distant URLs, assets clear!
Local paths and files that shine,
Demo images, now divine! ✨

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main changes: adding assets directory to package.json and updating the demo image path in README, which directly aligns with the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c970af4 and 195ee47.

⛔ Files ignored due to path filters (1)

• assets/demo.gif is excluded by !**/*.gif

📒 Files selected for processing (2)

• README.md
• package.json

🧰 Additional context used

📓 Path-based instructions (1)

package.json

📄 CodeRabbit inference engine (CLAUDE.md)

package.json: Use bun install instead of npm install, yarn install, or pnpm install
Use bun run <script> instead of npm run <script>, yarn run <script>, or pnpm run <script>

Files:

• package.json

🧠 Learnings (1)

📚 Learning: 2026-01-03T07:00:32.832Z

Learnt from: truehazker
Repo: truehazker/create-elysiajs PR: 2
File: templates/backend:1-1
Timestamp: 2026-01-03T07:00:32.832Z
Learning: In git diffs, symlinks (mode 120000) appear as added files containing the link target (e.g., +monorepo/apps/backend). Do not flag symlinks as placeholder files or accidental commits. This applies broadly; when reviewing files like templates/backend, verify whether it is a symlink and treat accordingly.

Applied to files:

• README.md
• package.json

🔇 Additional comments (2)

package.json (1)

45-45: Good addition to support local asset references.

Adding the "assets" directory to the files array ensures that the demo.gif referenced in README.md will be included in the published package. This eliminates dependency on external URLs.

README.md (1)

14-14: Local asset path improves package portability.

Using a relative path (./assets/demo.gif) is the correct approach for package distribution. The assets directory is included in the files array in package.json, so the image will be published with the package and will render correctly both on GitHub and on the npm website.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}