Improve README (#38)

* Improve README

* Update README.md

* small fix

---------

Co-authored-by: Ilan Uzan <[email protected]>

Author: doron050

README.md

@@ -1,5 +1,62 @@
 # sqlc-gen-csharp
+## Usage
+### Configuration
+```yaml
+version: "2"
+plugins:
+- name: csharp
+  wasm:
+    url: https://github.com/DionyOSS/sqlc-gen-csharp/releases/download/v0.10.0/sqlc-gen-csharp_0.10.0.wasm
+    sha256: 613ae249a541ab95c97b362bd1b0b572970edcad5eb2a11806a52d3f95e0f65f
+sql:
+  # PostgreSQL Example
+  - schema: "examples/authors/postgresql/schema.sql"
+    queries: "examples/authors/postgresql/query.sql"
+    engine: "postgresql"
+    codegen:
+      - plugin: csharp
+        out: NpgsqlExample
+        options:
+          driver: Npgsql
+          targetFramework: net8.0
+          generateCsproj: true
+          filePerQuery: false
+  # MySQL Example
+  - schema: "examples/authors/mysql/schema.sql"
+    queries: "examples/authors/mysql/query.sql"
+    engine: "mysql"
+    codegen:
+      - plugin: csharp
+        out: MySqlConnectorExample
+        options:
+          driver: MySqlConnector
+```
+### Options Documentation
+| Option     | Possible values | Info |
+|------------|---------------------------|-|
+| targetFramework | default: `net8.0`<br/>vaults: `netstandard2.0`, `netstandard2.1`, `net8.0` |Decide on the right target framework for your generated code, meaning the generated code will be compiled to the specified runtime.<br/>For more information and help deciding on the right value, refer to the [Microsoft .NET Standard documentation](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-1-0). |
+| generateCsproj      | default: `true`<br/>values: `false`,`true`  | This option is designed to assist you with the integration of SQLC and csharp by generating a `.csproj` file. This converts the generated output to a dynamic link library (DLL), simply a project that you can easily incorporate into your build process.  |
+| filePerQuery | default: `false`<br/>values: `false`,`true` | This option allows users control on which `.cs` files to generate, when false it's one file per `.sql` SQLC query file, and when true it's one file per query. |
+
+
+## Supported SQL Engines
+- MySQL via [MySqlConnector](https://www.nuget.org/packages/MySqlConnector) package - [MySqlConnectorDriver](MySqlConnectorDriver/MySqlConnectorDriver.csproj)
+- PostgreSQL via [Npgsql](https://www.nuget.org/packages/Npgsql) package - [NpgsqlDriver](NpgsqlDriver/NpgsqlDriver.csproj)
+
+
+## Examples & Tests
+The below examples in here are automatically tested:
+- [MySqlConnectorExample](MySqlConnectorExample/MySqlConnectorExample.csproj)
+- [NpgsqlExample](NpgsqlExample/NpgsqlExample.csproj)
 
+
+
+<br/>
+<br/>
+<br/>
+
+
+# Local plugin development
 ## Prerequisites
 make sure that the following applications are installed and exposed in your path
 
@@ -28,36 +85,3 @@ Testing the SQLC generated code via a predefined flow:
 make test-process-plugin
 make test-wasm-plugin
 ```
-
-## Supported SQL Engines
-- MySQL via [MySqlConnector](https://www.nuget.org/packages/MySqlConnector) package - [MySqlConnectorDriver](MySqlConnectorDriver/MySqlConnectorDriver.csproj)
-- PostgreSQL via [Npgsql](https://www.nuget.org/packages/Npgsql) package - [NpgsqlDriver](NpgsqlDriver/NpgsqlDriver.csproj)
-
-## Configuration
-Options available for plugin:
-```yaml
-version: "2"
-plugins:
-  - name: csharp
-    env:
-      - DEBUG
-    process:
-      cmd: ./dist/SqlcGenCsharpProcess
-sql:
-  - schema: "examples/authors/postgresql/schema.sql"
-    queries: "examples/authors/postgresql/query.sql"
-    engine: "postgresql"
-    codegen:
-      - plugin: csharp
-        out: NpgsqlExample
-        options:
-          driver: Npgsql
-          minimalCsharp: 7.0
-          filePerQuery: true
-          generateCsproj: false
-```
-
-## Examples & Tests
-The below examples in here are automatically tested:
-- [MySqlConnectorExample](MySqlConnectorExample/MySqlConnectorExample.csproj)
-- [NpgsqlExample](NpgsqlExample/NpgsqlExample.csproj)

sqlc.process.yaml

@@ -13,8 +13,8 @@ sql:
     options:
       driver: Npgsql
 #      targetFramework: netstandard2.0
-#      generateCsproj: false
-#      filePerQuery: true
+#      generateCsproj: true
+#      filePerQuery: false
 - schema: "examples/authors/mysql/schema.sql"
   queries: "examples/authors/mysql/query.sql"
   engine: "mysql"
@@ -23,6 +23,6 @@ sql:
     out: MySqlConnectorExample
     options:
       driver: MySqlConnector
-#      targetFramework: netstandard2.0
-#      generateCsproj: false
-#      filePerQuery: true
+#      targetFramework: netstandard2.0,netsandard2.1,net8.0
+#      generateCsproj: true
+#      filePerQuery: false

sqlc.wasm.yaml

@@ -3,7 +3,7 @@ plugins:
   - name: csharp
     wasm:
       url: file://dist/plugin.wasm
-      sha256: b4d5451ff1cfa49157408215674ba65838c0f3566bb5bd19d14ac9ecc62ab065
+      sha256: 613ae249a541ab95c97b362bd1b0b572970edcad5eb2a11806a52d3f95e0f65f
 sql:
   - schema: "examples/authors/postgresql/schema.sql"
     queries: "examples/authors/postgresql/query.sql"
@@ -14,8 +14,8 @@ sql:
         options:
           driver: Npgsql
           #      targetFramework: netstandard2.0
-          #      generateCsproj: false
-          #      filePerQuery: true
+          #      generateCsproj: true
+          #      filePerQuery: false
   - schema: "examples/authors/mysql/schema.sql"
     queries: "examples/authors/mysql/query.sql"
     engine: "mysql"
@@ -25,5 +25,5 @@ sql:
         options:
           driver: MySqlConnector
           #      targetFramework: netstandard2.0
-          #      generateCsproj: false
-          #      filePerQuery: true
+          #      generateCsproj: true
+          #      filePerQuery: false