chore(core): add readme

[NathanFlurry]

No description provided.

[claude]

Claude finished @NathanFlurry's task —— View job

---

PR Review: Adding READMEs and Package Keywords

I've reviewed this PR that adds README files to core packages and updates package.json files with keywords. Here's my detailed feedback:

Todo List:

• Review CLAUDE.md guidelines for README structure
• Examine new README files (db, rivetkit, sql-loader)
• Check modified README files for consistency
• Review package.json keyword additions
• Check for consistency across all packages
• Provide comprehensive feedback

🔍 Code Quality & Consistency Issues

README.md Structure Issues

1. Incorrect Subname Format (packages/db/README.md:1 and packages/sql-loader/README.md:1)

   • Current: # RivetKit Database and # RivetKit SQL Loader
   • Expected per CLAUDE.md guidelines: Should include descriptive subname format
   • Example: # RivetKit Database Driver or # RivetKit Database Adapter

2. Incorrect Tagline (packages/db/README.md:3 and packages/sql-loader/README.md:3)

   • Current: _Lightweight Libraries for Backends_
   • Expected per CLAUDE.md: _Library to build and scale stateful workloads_
   • Only packages/rivetkit/README.md:3 uses the correct tagline

3. Perfect Compliance (packages/rivetkit/README.md)

   • ✅ Follows CLAUDE.md structure exactly
   • ✅ Correct tagline and format

Missing Keywords in package.json

4. Incomplete Keywords (packages/db/package.json and packages/sql-loader/package.json)
   • These packages are missing keywords entirely
   • CLAUDE.md line 10 states: "Always include relevant keywords for the packages"
   • Should include keywords like: rivetkit, database, sql, adapter, etc.

🔧 Suggested Improvements

Fix README Taglines

# packages/db/README.md and packages/sql-loader/README.md
- _Lightweight Libraries for Backends_
+ _Library to build and scale stateful workloads_

Add Missing Keywords

# packages/db/package.json
+ "keywords": [
+   "rivetkit",
+   "database",
+   "sql",
+   "adapter",
+   "driver",
+   "serverless"
+ ],

# packages/sql-loader/package.json  
+ "keywords": [
+   "rivetkit", 
+   "sql",
+   "loader",
+   "migration",
+   "database",
+   "utilities"
+ ],

✅ What's Done Well

• Keyword Consistency: Existing packages (rivetkit, cloudflare-workers, next-js, react) have comprehensive, relevant keywords
• README Structure: All READMEs follow the basic template structure with proper links
• Package Compliance: The main rivetkit package README is perfectly compliant

🚫 No Security or Performance Issues

• No security concerns identified
• No performance impacts from documentation changes
• No test coverage issues (documentation-only changes)

📝 Summary

This PR makes good progress on documentation standardization but has some consistency issues with README taglines and missing keywords in two packages. The changes align with the project's documentation standards once the above issues are addressed.

[NathanFlurry]

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

• fix(core): fix websockets #1229
• fix(inspector): make inspector work again #1228
• chore(core): remove manager driver #1227
• fix(core): fix issue deserializing WebSocket message with BARE #1226
• chore(core): fix simple engine test #1225
• chore(core): simplify engine keys #1224
• chore(core): remove engine runner addresses config #1223
• chore(core): add welcome message #1222
• chore(fs): remove unneeded warning for onRunnerStart #1221
• chore(core): add readme #1220 👈 (View in Graphite)
• chore(core): add logger to engine runner #1219
• chore(core): update engine runner #1218
• main

---

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

• merge queue - adds this PR to the back of the merge queue
• hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

[pkg-pr-new]

More templates

• example-ai-agent
• example-better-auth-external-db
• chat-room
• example-cloudflare-workers
• example-cloudflare-workers-hono
• counter
• example-crdt
• example-database
• example-sqlite
• example-elysia
• example-express
• example-game
• example-hono
• example-hono-react
• example-next-js
• example-rate
• example-raw-fetch-handler
• example-raw-websocket-handler-proxy
• example-react
• starter
• example-stream
• example-sync
• example-tenant
• example-trpc

@rivetkit/actor

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/actor@1220

@rivetkit/cloudflare-workers

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/cloudflare-workers@1220

@rivetkit/core

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/core@1220

@rivetkit/db

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/db@1220

@rivetkit/framework-base

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/framework-base@1220

@rivetkit/next-js

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/next-js@1220

@rivetkit/react

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/react@1220

rivetkit

pnpm add https://pkg.pr.new/rivet-gg/rivetkit@1220

@rivetkit/sql-loader

pnpm add https://pkg.pr.new/rivet-gg/rivetkit/@rivetkit/sql-loader@1220

commit: d91b216