docs: add marmot pixel art illustrations to each README section

[dannym-arx]

Every section of the README now has its own hand-crafted marmot pixel art illustration — from the doctor at the CRT terminal to the astronaut deploying to the cloud — giving the docs the same retro JRPG personality as the app itself. Eight unique 16-bit scenes, one per section, each thematically matched to the content it introduces.

[coderabbitai]

Walkthrough

Adds presentational documentation to the repository: expands README.md with badges and structured sections and adds a new LICENSE file containing the MIT License. No code, API, or runtime behavior was changed.

Changes

Cohort / File(s)	Summary
README updates README.md	Inserted image badges and multiple section headings (examination steps, running locally, deploying, how it works, project structure, tech stack, browser requirements, related). Presentation-only edits; no behavior changes.
License added LICENSE	Added MIT License file with standard copyright and disclaimer text for Marmot Protocol (2024).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs(readme): add readme #1 — Initial README content added; this PR augments that documentation with badges and structured headings.

Suggested labels

documentation

---

🔕 Pre-merge checks override applied

The pre-merge checks have been overridden successfully. You can now proceed with the merge.

Overridden by @dannym-arx via checkbox on 2026-03-04T12:29:23.963Z.

❌ Failed checks (1 error, 1 warning)

Check name	Status	Explanation	Resolution
Title check	❌ Error [IGNORED]	Title follows conventional commits format (docs:) and is concise, but the actual changeset adds README sections and LICENSE file, not pixel art illustrations as claimed.	Revise title to accurately reflect the changes: 'docs: add README sections, badges, and MIT LICENSE' or similar, since no actual pixel art files were added to the repository.
Description check	⚠️ Warning	Description claims pixel art illustrations were added to README sections, but the actual changes are text/markdown formatting additions and a LICENSE file—no image files or embedded pixel art.	Update description to match the actual changeset: README restructuring with new sections and headings, plus LICENSE addition. Remove references to pixel art unless image files are actually included.

✅ Passed checks (5 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Dom Queries Centralized	✅ Passed	PR modifies only README.md and LICENSE files with zero JavaScript modifications, so the DOM query method check has nothing to diagnose.
No Mixed Exports	✅ Passed	PR only modifies README.md and LICENSE—documentation files with no code changes. Codebase scan confirms no mixed export patterns across 21 export-containing files.
No Alert()	✅ Passed	Comprehensive search found no alert() calls in JavaScript files; codebase correctly uses say() function from dialog.js for user-facing messages.
No Exceptions In Module Exports	✅ Passed	Pull request modifies only documentation files (README.md and LICENSE). No JavaScript/TypeScript modules or exports were changed, so the 'throw new Error' rule cannot be violated.

---

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

[github-actions]

🔍 Dr. Marmot Preview

Link	URL
Deployment	https://9bf7182b.dr-marmot.pages.dev
Branch alias	https://pr-13.dr-marmot.pages.dev

[coderabbitai]

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 60: Replace the repeated word "needed" in the README by updating the
sentence "Drop the files on any static host (GitHub Pages, Netlify, Vercel,
Cloudflare Pages). No configuration needed." to use the suggested alternative
wording; for example change it to "Drop the files on any static host (GitHub
Pages, Netlify, Vercel, Cloudflare Pages). Zero configuration required." to
eliminate vocabulary repetition with the "Running Locally" section.
- Around line 117-122: Add a "License" section at the end of README.md (after
the "Related" section) that names the project's license, includes a short
one-line summary and a link to the repository's LICENSE file (and optionally a
license badge); ensure the section header is "License" and that the README
references the LICENSE file so users can easily find the full terms.
- Around line 112-116: Add a "Browser Requirements" subsection (or expand the
existing "Tech Stack" bullets) that states this project requires modern browsers
with native ES module support and lists minimum versions (Chrome 61+, Firefox
60+, Safari 11+, Edge 16+) and a note that no build step means static-file
deployment only; update README.md near the "Tech Stack" heading to include this
compatibility info and a short sentence about deploying as static files with no
bundler.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 7b999b10-bff8-432d-ace4-084446911304

📥 Commits

Reviewing files that changed from the base of the PR and between c860fab and 64e420f.

📒 Files selected for processing (1)

• README.md

📜 Review details

🧰 Additional context used

📓 Path-based instructions (2)

!main.js,**/*.js

📄 CodeRabbit inference engine (AGENTS.md)

Avoid side effects on import; only main.js is allowed to have side effects for initialization

Files:

• README.md

**/README.md

⚙️ CodeRabbit configuration file

**/README.md: README must include:

• Clear project description
• Installation/setup instructions
• Usage examples
• Browser compatibility notes (since no build step)
• License information
  Be encouraging but firm about documentation quality.

Files:

• README.md

🧠 Learnings (2)

📚 Learning: 2026-02-25T17:57:26.327Z

Learnt from: CR
Repo: marmot-protocol/dr.marmot PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-25T17:57:26.327Z
Learning: Deploy as static files only with no build step; use modern browsers with ES modules support

Applied to files:

• README.md

📚 Learning: 2026-02-25T17:57:26.327Z

Learnt from: CR
Repo: marmot-protocol/dr.marmot PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-25T17:57:26.327Z
Learning: Applies to **/*.js : Use ESM `import` statements from CDN (nostr-tools via https://esm.sh/nostr-tools) or local modules only; no npm dependencies

Applied to files:

• README.md

🪛 LanguageTool

README.md

[style] ~60-~60: This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional.
Context: ...el, Cloudflare Pages). No configuration needed. ## How It Works ![How It Works](http...

(EN_REPEATEDWORDS_NEED)

🔇 Additional comments (2)

README.md (2)

5-6: Visual diagnosis: healthy branding.

The header image establishes the retro JRPG personality immediately. Hosting on Blossom (Nostr media) is thematically consistent for a Nostr tool.

---

11-12: Pixel art prescription approved.

Eight unique illustrations, thematically matched to content. The retro JRPG aesthetic is now consistently applied throughout the documentation. Implementation is clean and uniform.

Also applies to: 39-40, 58-59, 64-65, 75-76, 110-111, 119-120

[coderabbitai]

♻️ Duplicate comments (1)

README.md (1)

60-60: 🧹 Nitpick | 🔵 Trivial

Tiny wording nit (yes, this is the pedantic one).

Line 60 repeats “needed” from earlier nearby copy; consider “Zero configuration required” for smoother prose.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 60, Replace the sentence "Drop the files on any static
host (GitHub Pages, Netlify, Vercel, Cloudflare Pages). No configuration
needed." in the README with smoother wording such as "Drop the files on any
static host (GitHub Pages, Netlify, Vercel, Cloudflare Pages). Zero
configuration required." — update that exact sentence to avoid the repeated word
"needed" while preserving the host examples and meaning.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@README.md`:
- Line 60: Replace the sentence "Drop the files on any static host (GitHub
Pages, Netlify, Vercel, Cloudflare Pages). No configuration needed." in the
README with smoother wording such as "Drop the files on any static host (GitHub
Pages, Netlify, Vercel, Cloudflare Pages). Zero configuration required." —
update that exact sentence to avoid the repeated word "needed" while preserving
the host examples and meaning.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: cd9f7756-2f4f-43e6-99fc-9eb93c96d6ec

📥 Commits

Reviewing files that changed from the base of the PR and between 64e420f and 0015016.

📒 Files selected for processing (2)

• LICENSE
• README.md

📜 Review details

🧰 Additional context used

📓 Path-based instructions (2)

!main.js,**/*.js

📄 CodeRabbit inference engine (AGENTS.md)

Avoid side effects on import; only main.js is allowed to have side effects for initialization

Files:

• README.md
• LICENSE

**/README.md

⚙️ CodeRabbit configuration file

**/README.md: README must include:

• Clear project description
• Installation/setup instructions
• Usage examples
• Browser compatibility notes (since no build step)
• License information
  Be encouraging but firm about documentation quality.

Files:

• README.md

🧠 Learnings (2)

📚 Learning: 2026-02-25T17:57:26.327Z

Learnt from: CR
Repo: marmot-protocol/dr.marmot PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-25T17:57:26.327Z
Learning: Deploy as static files only with no build step; use modern browsers with ES modules support

Applied to files:

• README.md

📚 Learning: 2026-02-25T17:57:26.327Z

Learnt from: CR
Repo: marmot-protocol/dr.marmot PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-02-25T17:57:26.327Z
Learning: Applies to **/*.js : Use ESM `import` statements from CDN (nostr-tools via https://esm.sh/nostr-tools) or local modules only; no npm dependencies

Applied to files:

• README.md

🪛 LanguageTool

README.md

[style] ~60-~60: This word has been used in one of the immediately preceding sentences. Using a synonym could make your text more interesting to read, unless the repetition is intentional.
Context: ...el, Cloudflare Pages). No configuration needed. ## How It Works ![How It Works](http...

(EN_REPEATEDWORDS_NEED)

🔇 Additional comments (2)

LICENSE (1)

1-21: MIT license block looks correct and complete.

Good addition—this is the standard MIT text with the required grant/conditions/disclaimer sections intact.

README.md (1)

117-137: Nice recovery: browser compatibility + license are now explicitly documented.

This closes the critical docs gaps and matches the project’s no-build-step deployment model. Clean and user-friendly.
As per coding guidelines: "README must include: Browser compatibility notes (since no build step)" and "License information". Based on learnings: "Deploy as static files only with no build step; use modern browsers with ES modules support".