From 109c72e84f18e43ca3ab2793c7d041ae02ce702c Mon Sep 17 00:00:00 2001 From: dswbx Date: Thu, 3 Jul 2025 15:31:14 +0200 Subject: [PATCH] update readme and docs on dbs --- README.md | 8 ++++++++ bun.lock | 2 +- docs/usage/database.mdx | 14 ++++++++------ 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d473e36..41ae4b1 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,18 @@

bknd simplifies app development by providing a fully functional backend for database management, authentication, media and workflows. Being lightweight and built on Web Standards, it can be deployed nearly anywhere, including running inside your framework of choice. No more deploying multiple separate services! +* **Runtimes**: Node.js 22+, Bun 1.0+, Deno, Browser, Cloudflare Workers/Pages, Vercel, Netlify, AWS Lambda, etc. +* **Databases**: + * SQLite: LibSQL, Node SQLite, Bun SQLite, Cloudflare D1, Cloudflare Durable Objects SQLite, SQLocal + * Postgres: Vanilla Postgres, Supabase, Neon, Xata +* **Frameworks**: React, Next.js, React Router, Astro, Vite, Waku +* **Storage**: AWS S3, S3-compatible (Tigris, R2, Minio, etc.), Cloudflare R2 (binding), Cloudinary **For documentation and examples, please visit https://docs.bknd.io.** > [!WARNING] +> This project requires Node.js 22 or higher (because of `node:sqlite`). +> > Please keep in mind that **bknd** is still under active development > and therefore full backward compatibility is not guaranteed before reaching v1.0.0. diff --git a/bun.lock b/bun.lock index 3a98944..7f982e0 100644 --- a/bun.lock +++ b/bun.lock @@ -15,7 +15,7 @@ }, "app": { "name": "bknd", - "version": "0.15.0-rc.9", + "version": "0.15.0-rc.10", "bin": "./dist/cli/index.js", "dependencies": { "@cfworker/json-schema": "^4.1.1", diff --git a/docs/usage/database.mdx b/docs/usage/database.mdx index dc520d2..8a43de3 100644 --- a/docs/usage/database.mdx +++ b/docs/usage/database.mdx @@ -107,8 +107,8 @@ import { libsql } from "bknd/data"; export default { connection: libsql({ - url: "libsql://your-database-url.turso.io", - authToken: "your-auth-token", + url: "libsql://.turso.io", + authToken: "", }), } as const satisfies BkndConfig; ``` @@ -120,11 +120,13 @@ import type { BkndConfig } from "bknd"; import { libsql } from "bknd/data"; import { createClient } from "@libsql/client"; +const client = createClient({ + url: "libsql://.turso.io", + authToken: "", +}) + export default { - connection: libsql(createClient({ - url: "libsql://your-database-url.turso.io", - authToken: "your-auth-token", - })), + connection: libsql(client), } as const satisfies BkndConfig; ```