update docs (#59)

Co-authored-by: SockworkOrange <[email protected]>
DaredevilOSS · Jun 17, 2024 · 1c3a3fd · 1c3a3fd
1 parent 295c522
commit 1c3a3fd
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/docs/Examples.md b/docs/Examples.md
@@ -0,0 +1,25 @@
+# Examples
+## Engine `postgresql`: [NpgsqlExample](../NpgsqlExample)
+
+### [Schema](../examples/authors/postgresql/schema.sql) | [Queries](../examples/authors/postgresql/query.sql) | [End2End Test](../EndToEndTests/NpgsqlTester.cs)
+
+### Config
+```yaml
+driver: Npgsql
+filePerQuery: false
+targetFramework: net8.0
+generateCsproj: true
+```
+
+## Engine `mysql`: [MySqlConnectorExample](../MySqlConnectorExample)
+
+### [Schema](../examples/authors/mysql/schema.sql) | [Queries](../examples/authors/mysql/query.sql) | [End2End Test](../EndToEndTests/MySqlConnectorTester.cs)
+
+### Config
+```yaml
+driver: MySqlConnector
+filePerQuery: false
+targetFramework: net8.0
+generateCsproj: true
+```
+