diff --git a/README.md b/README.md index b6e88fa..7c7e248 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,22 @@ # DB0 - + [![npm version](https://flat.badgen.net/npm/v/db0)](https://npmjs.com/package/db0) [![npm downloads](https://flat.badgen.net/npm/dm/db0)](https://npmjs.com/package/db0) -> DB0 provides an easy interface to connect and query sql databases providers with a tiny core. +> [!IMPORTANT] +> DB0 development is in the early stages. Followup progress via [GitHub issues](https://github.com/unjs/db0/issues). + +DB0 is a lightweight SQL connector: + +✅ Works with several SQL [connectors](/connectors). + +✅ Can be [integrated](/integrations) with ORMs and embeded into frameworks. + +✅ Provides a simple but elegant query API out of the box. 👉 Read [📚 Documentation](https://db0.unjs.io) diff --git a/docs/.config/docs.yaml b/docs/.config/docs.yaml index 29b4cde..92a391f 100644 --- a/docs/.config/docs.yaml +++ b/docs/.config/docs.yaml @@ -1,8 +1,8 @@ # yaml-language-server: $schema=https://unpkg.com/undocs/schema/config.json name: "db0" -shortDescription: "databases, made simple." -description: "Connect and query any SQL compatible database." +shortDescription: "tiny sql connector" +description: "Connect and query any compatible SQL database and integrate with your favorite tools." github: "unjs/db0" url: "https://db0.unjs.io" automd: true diff --git a/docs/1.guide/1.index.md b/docs/1.guide/1.index.md index 6e34c2d..267d8d0 100644 --- a/docs/1.guide/1.index.md +++ b/docs/1.guide/1.index.md @@ -4,12 +4,18 @@ icon: ph:book-open-duotone # Getting Started -> db0 provides an easy way to connect and query sql databases providers. - -DB0 provides Elegant API to query your databases. It is designed to work in all JavaScript runtimes and with different Database types using [connectors](/connectors). +> db0 provides an easy way to connect and query sql database providers. > [!IMPORTANT] -> DB0 is under development and API might change. +> DB0 development is in the early stages. Followup progress via [GitHub issues](https://github.com/unjs/db0/issues). + +DB0 is a lightweight SQL connector: + +✅ Works with several SQL [connectors](/connectors). + +✅ Can be [integrated](/integrations) with ORMs and embeded into frameworks. + +✅ Provides a simple but elegant query API out of the box. ## Quick start diff --git a/docs/1.guide/4.custom-connector.md b/docs/1.guide/4.custom-connector.md index ac4bcba..c3a80eb 100644 --- a/docs/1.guide/4.custom-connector.md +++ b/docs/1.guide/4.custom-connector.md @@ -4,11 +4,11 @@ icon: material-symbols-light:dashboard-customize # Custom Connectors -If there is no built-in connector yet for a SQL database integration, you can create a custom one by yourself. +> If there is no built-in connector yet for a SQL database integration, you can create a custom one by yourself. ::read-more{to="https://github.com/unjs/db0/tree/main/src/connectors"} Explore [built-in connectors](https://github.com/unjs/db0/tree/main/src/connectors) to learn how to implement a custom connector. :: > [!NOTE] -> Feel free to [request new a new connector](https://github.com/unjs/db0/issues/new?assignees=&labels=connector&projects=&template=feature-request.yml). +> [Request](https://github.com/unjs/db0/issues/new?assignees=&labels=connector&projects=&template=feature-request.yml) a new connector. diff --git a/docs/2.connectors/1.index.md b/docs/2.connectors/1.index.md index 064680f..e4e02ab 100644 --- a/docs/2.connectors/1.index.md +++ b/docs/2.connectors/1.index.md @@ -6,4 +6,9 @@ icon: gravity-ui:plug-connection > You can use DB0 api with the connector of your own choice. -See left sections for each connector instructions. +Currently supported connectos: + +- [Cloudflare D1](/connectors/cloudflare) +- [LibSQL](/connectors/libsql) +- [PostgreSQL](/connectors/postgresql) +- [SQLite](/connectors/sqlite) diff --git a/docs/2.connectors/planetscale.md b/docs/2.connectors/planetscale.md index 79c445c..65191af 100644 --- a/docs/2.connectors/planetscale.md +++ b/docs/2.connectors/planetscale.md @@ -11,17 +11,3 @@ icon: simple-icons:planetscale > [!WARNING] > 🚀 This connector will be supported soon! Follow up via [unjs/db0#4](https://github.com/unjs/db0/issues/4). -## Usage - -Use `planetscale` connector: - -```js -import { createDatabase, sql } from "db0"; -import planetscale from "db0/connectors/planetscale"; - -const db = createDatabase( - planetscale({ - /* options */ - }), -); -``` diff --git a/docs/2.connectors/turso.md b/docs/2.connectors/turso.md index 8544fb0..62ae0ed 100644 --- a/docs/2.connectors/turso.md +++ b/docs/2.connectors/turso.md @@ -10,16 +10,3 @@ icon: simple-icons:turso > [!WARNING] > 🚀 This connector will be supported soon! Follow up via [unjs/db0#11](https://github.com/unjs/db0/issues/11). - -Use ~~`turso`~~ connector: - -```js -import { createDatabase, sql } from "db0"; -import vercelPostgres from "db0/connectors/turso"; - -const db = createDatabase( - turso({ - /* options */ - }), -); -``` diff --git a/docs/3.integrations/1.index.md b/docs/3.integrations/1.index.md index 02357b9..5c2eb29 100644 --- a/docs/3.integrations/1.index.md +++ b/docs/3.integrations/1.index.md @@ -6,4 +6,6 @@ icon: carbon:property-relationship > You can integrate DB0 instance to ORM or framework of your choice. -See left sections for each integration instructions. +Currently supported integrations: + +- [Drizzle](/integrations/drizzle)