diff --git a/README.md b/README.md index 93b1e58..23d2096 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ + + # DuckDB Copilot Extension Experimental extension to run DuckDB as a Copilot Extension helper @@ -12,6 +14,36 @@ npm run dev open http://localhost:3000 ``` -## Development Environment +> Follow the `/docs` instructions to register your Copilot Extension + +## Examples +### Basic Queries +``` +@duckdb-copilot SELECT 1, 2, 3 +``` + +### Table Persistence +``` +@duckdb-copilot CREATE TABLE cities ( + name VARCHAR, + country VARCHAR +); +``` + +``` +@duckdb-copilot INSERT INTO cities +VALUES ('San Francisco', 'US'), ('Amsterdam','NL'), ('Bologna','IT'); +``` + +``` +@duckdb-copilot SELECT * FROM cities +``` -To get up and running with your development environment, see the [Development Guide](./docs/DEVELOPMENT_SETUP.md). +### LLM SQL +``` +@duckdb-copilot show all entries from cities +``` + +``` +@duckdb-copilot show the duckdb version +```