Skip to content

docs: rewrite README for current agent state#323

Open
jrothrock wants to merge 1 commit into
masterfrom
docs/update-readme
Open

docs: rewrite README for current agent state#323
jrothrock wants to merge 1 commit into
masterfrom
docs/update-readme

Conversation

@jrothrock
Copy link
Copy Markdown
Collaborator

Summary

  • Updates Node requirement to ≥18 and replaces the old scout.install() API with scout.init()
  • Adds TypeScript and NestJS quick-start examples
  • Expands integrations table: mongodb, prisma, ioredis, redis, fetch, NestJS added; Nuxt removed; all entries marked STABLE
  • Adds configuration table, custom instrumentation examples, and Node version support matrix (18/20/22/24)
  • Replaces stale make/tslint dev commands with npm run / eslint

Test plan

  • README renders correctly on GitHub
  • All code examples match current API (scout.init, expressMiddleware, nestMiddleware, nestErrorFilter)
  • No references to removed integrations (Nuxt) or deprecated APIs (scout.install)

🤖 Generated with Claude Code

- Update Node requirement to ≥18 (AsyncLocalStorage baseline)
- Replace scout.install() with scout.init() throughout examples
- Add TypeScript and NestJS quick-start examples
- Add configuration table (name, key, monitor, logLevel)
- Expand integrations table: add mongodb, prisma, ioredis, redis, fetch,
  NestJS; remove Nuxt; mark all entries STABLE
- Add custom instrumentation examples (web/background transactions, spans, context)
- Add Node version support matrix (18/20/22/24)
- Replace make/tslint dev commands with npm run / eslint

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jrothrock jrothrock force-pushed the docs/update-readme branch from f3dcbe7 to 5fc9c5f Compare May 28, 2026 23:05
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.

1 participant