Skip to content

docs: add npm package links and badges - #6

Merged
prdai merged 2 commits into
mainfrom
docs/npm-links
Jun 20, 2026
Merged

docs: add npm package links and badges#6
prdai merged 2 commits into
mainfrom
docs/npm-links

Conversation

@prdai

@prdai prdai commented Jun 20, 2026

Copy link
Copy Markdown
Member

Now that drizzle-cloudflare-kv-cache-adapter is live on npm (v0.1.0), surface it everywhere.

Changes

  • README: badge row (npm version, monthly downloads, CI status, license) + 📦 npm / 📖 Docs quick links under the tagline.
  • Docs hero: added an npm action button.
  • Introduction + Getting started: links to the npm package page.

No code changes.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added npm package links and badges to the README and documentation homepage
    • Enhanced visibility of package availability on npm with direct access links
    • Updated getting started and introduction docs with npm package references

- README: npm version/downloads/CI/license badges + npm & docs quick links.
- Docs hero: 'npm' action button.
- Introduction + getting-started: links to the npm package page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Jun 20, 2026

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Updated (UTC)
✅ Deployment successful!
View logs
drizzle-kv-cache-docs 0c51de5 Jun 20 2026, 06:13 PM

@coderabbitai

coderabbitai Bot commented Jun 20, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@prdai, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 57 minutes and 35 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 83b903cc-7f25-4753-ae9c-bd912985c6bb

📥 Commits

Reviewing files that changed from the base of the PR and between 7ca52b2 and 0c51de5.

📒 Files selected for processing (3)
  • README.md
  • docs/src/content/docs/index.mdx
  • docs/src/content/docs/introduction.md

Walkthrough

Adds npm version, downloads, CI status, and MIT license shield badges to README.md along with npm/docs links. Adds an npm hero action button to the docs homepage, a "view on npm" hyperlink in the getting started page, and an npm availability note with the package name in the introduction.

Changes

npm Badges and Links

Layer / File(s) Summary
npm badges, hero action, and doc links
README.md, docs/src/content/docs/index.mdx, docs/src/content/docs/getting-started.mdx, docs/src/content/docs/introduction.md
README.md gets shield badges (npm version, downloads, CI, MIT) plus npm/docs link row; docs homepage adds an npm hero action button with external/minimal styling; getting started install step gains a "view on npm" hyperlink; introduction adds the package name drizzle-cloudflare-kv-cache-adapter with a link to its npm page.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🏷️ Badges pinned, the README gleams,
npm links stitched into the docs' seams.
A hero button, a note, a link —
Four files touched in barely a blink.
Ship it fast, no need to think! 🚀

🚥 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 title 'docs: add npm package links and badges' directly and accurately describes the main changes across all modified files—adding npm package links and badges to documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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 docs/npm-links

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

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

Clarify the project is independent and not affiliated with or endorsed by
Drizzle ORM or Cloudflare; their trademarks belong to them. Added to README,
the docs Introduction, and the home page.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@prdai
prdai merged commit 7bd4699 into main Jun 20, 2026
1 of 3 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.

1 participant