Skip to content

Commit 7bd4699

Browse files
prdaiclaude
andauthored
docs: add npm package links and badges (#6)
* docs: add npm package links and badges - 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> * docs: add non-affiliation / trademark disclaimer 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> --------- Co-authored-by: prdai <prdai@users.noreply.github.com> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent b18acea commit 7bd4699

4 files changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,15 @@
44

55
# Drizzle Cloudflare KV Cache Adapter
66

7+
[![npm version](https://img.shields.io/npm/v/drizzle-cloudflare-kv-cache-adapter.svg?logo=npm)](https://www.npmjs.com/package/drizzle-cloudflare-kv-cache-adapter)
8+
[![npm downloads](https://img.shields.io/npm/dm/drizzle-cloudflare-kv-cache-adapter.svg)](https://www.npmjs.com/package/drizzle-cloudflare-kv-cache-adapter)
9+
[![CI](https://github.com/BitByBit-B3/drizzle-cloudflare-kv-cache-adapter/actions/workflows/ci.yml/badge.svg)](https://github.com/BitByBit-B3/drizzle-cloudflare-kv-cache-adapter/actions/workflows/ci.yml)
10+
[![license: MIT](https://img.shields.io/npm/l/drizzle-cloudflare-kv-cache-adapter.svg)](./LICENSE)
11+
712
Cloudflare KV query caching for Drizzle ORM — cache read-heavy Drizzle queries on Workers/D1 without adding Redis.
813

14+
📦 **[npm](https://www.npmjs.com/package/drizzle-cloudflare-kv-cache-adapter)** · 📖 **[Docs](https://drizzle-kv-cache.bbyb.dev)**
15+
916
A [Cloudflare KV](https://developers.cloudflare.com/kv/)-backed implementation of Drizzle ORM's [cache](https://orm.drizzle.team/docs/cache) interface. Designed for Cloudflare Workers, D1, and read-heavy serverless apps that want Drizzle query caching without standing up Redis or Upstash.
1017

1118
> This is **not** a database driver. It only implements Drizzle's query cache layer (`.$withCache()` and `db.$cache.invalidate(...)`).
@@ -136,6 +143,10 @@ bun run build
136143

137144
Contributions are welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for the dev setup and PR workflow, and our [Code of Conduct](./CODE_OF_CONDUCT.md). Notable changes are tracked in [CHANGELOG.md](./CHANGELOG.md).
138145

146+
## Disclaimer
147+
148+
This is an independent, community-maintained project. It is **not affiliated with, endorsed by, or sponsored by** Drizzle ORM or Cloudflare, Inc. "Drizzle", "Cloudflare", "Cloudflare Workers", "Workers KV", and "D1" are trademarks of their respective owners and are used here for identification purposes only.
149+
139150
## License
140151

141152
[MIT](./LICENSE) © BitByBit-B3

docs/src/content/docs/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Steps, Tabs, TabItem } from '@astrojs/starlight/components';
77

88
<Steps>
99

10-
1. **Install the package**
10+
1. **Install the package** ([view on npm](https://www.npmjs.com/package/drizzle-cloudflare-kv-cache-adapter))
1111

1212
<Tabs syncKey="pkg">
1313
<TabItem label="bun">

docs/src/content/docs/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ hero:
3131
link: https://github.com/BitByBit-B3/drizzle-cloudflare-kv-cache-adapter
3232
icon: external
3333
variant: minimal
34+
- text: npm
35+
link: https://www.npmjs.com/package/drizzle-cloudflare-kv-cache-adapter
36+
icon: external
37+
variant: minimal
3438
---
3539

3640
import { Card, CardGrid } from '@astrojs/starlight/components';
@@ -53,3 +57,5 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
5357
typed.
5458
</Card>
5559
</CardGrid>
60+
61+
<small>Independent, community-maintained project — not affiliated with or endorsed by Drizzle ORM or Cloudflare, Inc. All trademarks belong to their respective owners. See the [Introduction](/introduction/#disclaimer) for details.</small>

docs/src/content/docs/introduction.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: What the Drizzle Cloudflare KV cache adapter is, and when to reach
55

66
![Drizzle Cloudflare KV Cache Adapter — Cloudflare KV-backed query caching for Drizzle ORM](../../assets/banner.png)
77

8+
Available on npm as [`drizzle-cloudflare-kv-cache-adapter`](https://www.npmjs.com/package/drizzle-cloudflare-kv-cache-adapter).
9+
810
A [Cloudflare KV](https://developers.cloudflare.com/kv/)-backed implementation of Drizzle ORM's [cache](https://orm.drizzle.team/docs/cache) interface. It caches read-heavy Drizzle queries at the edge using the KV namespace you already have bound to your Worker.
911

1012
:::note
@@ -31,3 +33,7 @@ Drizzle's cache layer ships with a Redis/Upstash adapter out of the box. On Clou
3133

3234
- `drizzle-orm >= 0.44.0`
3335
- A bound `KVNamespace` in your Worker (`env.CACHE` or similar).
36+
37+
## Disclaimer
38+
39+
This is an independent, community-maintained project. It is **not affiliated with, endorsed by, or sponsored by** Drizzle ORM or Cloudflare, Inc. "Drizzle", "Cloudflare", "Cloudflare Workers", "Workers KV", and "D1" are trademarks of their respective owners and are used here for identification purposes only.

0 commit comments

Comments
 (0)