Skip to content

feat: enhance README with badges, comparison table and FAQ#21

Merged
codewizdave merged 2 commits into
mainfrom
seo/readme-enhancements
Jun 4, 2026
Merged

feat: enhance README with badges, comparison table and FAQ#21
codewizdave merged 2 commits into
mainfrom
seo/readme-enhancements

Conversation

@martyy-code

Copy link
Copy Markdown
Contributor

Summary

Improve README with SEO-friendly enhancements:

  • Badges — npm version, TypeScript, License (badges generate backlinks for SEO)
  • "Why @deessejs/errors?" — Comparison table vs built-in Error, code examples
  • FAQ — Common questions targeting long-tail search queries
  • Sync — Root README mirrors package README for consistency

Changes

Section Addition
Badges npm, TypeScript, License
Why this? 5-row comparison table
FAQ 3 common questions with code
Sync packages/errors/README.md ↔ root README.md

SEO Impact

  • Badges create backlinks from shields.io and GitHub
  • Comparison table targets "vs built-in error" queries
  • FAQ targets question-based search intent
  • Structured content improves readability

Test plan

  • pnpm build passes
  • Review rendered README on GitHub
  • Verify badges load correctly

🤖 Generated with Claude Code

martyy-code and others added 2 commits June 4, 2026 10:13
- Expand npm keywords from 4 to 10 (exception-chaining, hierarchical-errors, python-style-errors, custom-error-types, nodejs, npm-package)
- Add README.md to packages/errors/ for npm page display

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
- Add npm, TypeScript, and License badges
- Add "Why @deessejs/errors?" section with comparison table
- Add FAQ section for common questions (custom errors, chaining, type checking)
- Sync root README with package README

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
errors-web Ready Ready Preview, Comment Jun 4, 2026 8:23am

@codewizdave codewizdave merged commit 7ad2c0e into main Jun 4, 2026
6 checks passed
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.

2 participants