docs: Restore dep-charge README

[yousecjoe]

Summary

Fixes #12.

Commit a6cace5 unintentionally replaced the original dep-charge README with the default SvelteKit sv create boilerplate. This PR restores the project description and rewrites the build instructions to match the project's actual Bun-based tooling (per CLAUDE.md).

Changes

• Restore the original dep-charge tagline ("1–10 breach-likelihood rating")
• Add a short summary of the input methods (upload / paste / Git URL / local path) and SSE-streamed output
• List the actual tech stack: Bun, SvelteKit 2 + Svelte 5 (runes), TypeScript, Anthropic SDK
• Replace npm run … boilerplate with bun run dev | build | preview | check
• Document the env.example → .env.local setup with ANTHROPIC_API_KEY and optional CLAUDE_MODEL
• Add MIT / Young Security license line

Test plan

• README.md no longer contains the sv template content
• Original dep-charge tagline is present
• Build/run instructions use bun run …
• Environment setup referencing env.example / ANTHROPIC_API_KEY is documented
• License line is present
• bun run check still passes (no source changes, docs-only)

Summary by CodeRabbit

• Documentation

  • Updated project name and setup instructions
  • Added environment configuration requirements
  • Updated development and build commands to use Bun

• Chores

  • Added license attribution

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 29186b0d-43e3-4538-b174-0c5551b226ce

📥 Commits

Reviewing files that changed from the base of the PR and between 7056ad9 and 95e24e3.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

The README was restored from SvelteKit boilerplate to project-specific documentation for dep-charge, a dependency security analysis tool. Instructions were updated to reflect Bun-based tooling and Anthropic API configuration requirements.

Changes

Cohort / File(s)	Summary
README Update README.md	Replaced SvelteKit template boilerplate with dep-charge project description, setup instructions (Bun runtime, .env.local configuration with ANTHROPIC_API_KEY), dev/build/preview/check commands using bun run, and MIT license attribution.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 Hoppy Docs!
The boilerplate has hopped away,
Now dep-charge takes the stage to stay,
With Bun and Claude in harmony,
Security rated, one through ten you'll see! 🔐✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs: Restore dep-charge README' directly and concisely describes the main change: restoring the original README that was accidentally overwritten.
Linked Issues check	✅ Passed	All requirements from issue #12 are met: sv template content removed, original tagline restored, bun commands documented, env.example/ANTHROPIC_API_KEY setup included, and license attribution added.
Out of Scope Changes check	✅ Passed	The changes are limited to README.md only and directly address issue #12's objectives; no out-of-scope modifications are present.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch claude/restore-readme-dep-charge-021nM

Warning

Review ran into problems

🔥 Problems

Errors were encountered while retrieving linked issues.

Errors (1)

• JIRA integration encountered authorization issues. Please disconnect and reconnect the integration in the CodeRabbit UI.

---

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.}