docs(ext-driver-duckdb): update readme and dev warning

Author: oscar60310

packages/extension-driver-duckdb/README.md

@@ -1,11 +1,26 @@
 # extension-driver-duckdb
 
-This library was generated with [Nx](https://nx.dev).
+[Duckdb](https://duckdb.org/) driver for Vulcan SQL
 
-## Building
+## Install
 
-Run `nx build extension-driver-duckdb` to build the library.
+1. Install package
 
-## Running unit tests
+   ```sql
+   npm i @vulcan-sql/extension-driver-duckdb
+   ```
 
-Run `nx test extension-driver-duckdb` to execute the unit tests via [Jest](https://jestjs.io).
+2. Update `vulcan.yaml`
+
+   ```yaml
+   extensions:
+     duckdb: '@vulcan-sql/extension-driver-duckdb'
+
+   duckdb:
+     # Optional: Path to your persistent DB, if this value is not set, we use in-memory database. (default: ":memory:")
+     persistent-path: 'path-to-a-folder'
+     # Optional: Whether log query requests (default: false)
+     log-queries: false
+     # Optional: Whether log query requests' parameters, please be aware that query parameters might contain sensitive data (default: false)
+     log-parameters: false
+   ```

packages/extension-driver-duckdb/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vulcan-sql/extension-driver-duckdb",
-  "description": "duckbe driver for Vulcan SQL",
+  "description": "duckdb driver for Vulcan SQL",
   "version": "0.1.0-alpha.1",
   "type": "commonjs",
   "publishConfig": {

packages/extension-driver-duckdb/src/lib/duckdbDataSource.ts

@@ -29,6 +29,9 @@ export interface DuckDBOptions {
   'log-parameters'?: boolean;
 }
 
+/// NOTICE: We're using the dev version of duckdb nodejs client for stream data support
+/// It might contain some issues.
+
 @VulcanExtensionId('duckdb')
 export class DuckDBDataSource extends DataSource<DuckDBOptions> {
   private db: duckdb.Database;