add astro-registry config

.astro-registry.yaml

@@ -0,0 +1,22 @@
+# This file is intended to be a file which specifically calls out modules to be published to the Astronomer
+# Registry as well as top-level Provider metadata. The file should not be packaged and solely lives in the
+# repo. The modules listed should pertain to latest, released version of the repo.
+
+# Python package name.
+package-name: duckdb_provider
+# The name of the provider to be displayed on the Registry.
+display-name: DuckDB Provider
+# A description to be displayed on the main Provider page.
+description: An Airflow provider to interact with DuckDB
+# URL for where user should find the documentation for the Provider. This could be a link to the README,
+# an external docs site, etc.
+docs_url: https://github.com/astronomer/airflow-provider-duckdb
+
+# The next sections should be organized by module type (e.g. operators, hooks, functions, decorators, etc.).
+#
+# Within each section, the ``module`` value should be the path.to.the.module.specifically.
+# For example, if the import path for a function is `from sample_provider.hooks.sample_hook import SampleHook` then the
+# value should be "sample_provider.hooks.sample_hook.SampleHook".
+
+hooks:
+  - module: duckdb_provider.hooks.duckdb_hook.DuckDBHook

README.md

@@ -14,6 +14,11 @@ The connection type is `duckdb`. It supports setting the following parameters:
 
 - `file` (optional): The path to the DuckDB database file. If not set, operations will be done in-memory.
 
+Example connection strings:
+
+- `duckdb://:memory:`
+- `duckdb:///tmp/duckdb.db`
+
 ## Usage
 
 ```python