Skip to content

Commit 060a99d

Browse files
authored
Update README.md (#108)
1 parent 2fc1e6f commit 060a99d

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<p align="center"><img src="https://github.com/DaredevilOSS/sqlc-gen-csharp/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></p>
33

44

5-
sqlc-gen-csharp is a .NET SQLC plugin global tool that generates strongly-typed SQL queries and corosponding code for various databases and C# target frameworks. It wrriten to work with the popular [sqlc](https://github.com/kyleconroy/sqlc) tool, which is written in golang and targets Go, Java, JavaScript, Kotlin, Python, Ruby, Rust, Swift, and TypeScript.
5+
sqlc-gen-csharp is a .Net plugin for [sqlc](https://github.com/sqlc-dev/sqlc).<br/> It leverages the SQLC plugin system to generate type-safe C# code for SQL queries, supporting PostgresSQL, MySQL & SQLite via the corresponding driver or suitable Dapper abstraction.
66

77
## Usage
88

@@ -13,7 +13,7 @@ sqlc-gen-csharp is a .NET SQLC plugin global tool that generates strongly-typed
1313
| targetFramework | default: `net8.0`<br/>values: `netstandard2.0`, `netstandard2.1`, `net8.0` | Yes | Determines the 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). |
1414
| generateCsproj | default: `true`<br/>values: `false`,`true` | Yes | Assists you with the integration of SQLC and csharp by generating a `.csproj` file. This converts the generated output to a .dll, a project that you can easily incorporate into your build process. |
1515
| namespaceName | default: the generated project name | Yes | Allows you to override the namespace name to be different than the project name |
16-
| useDapper | default: `false`<br/>values: `false`,`true` | Yes | Enables Dapper as the ORM of choice for your generated code. When enabled, the generated code will use Dapper to execute SQL queries and map results to objects. For more information, refer to the [Dapper documentation](https://github.com/DapperLib/Dapper). |
16+
| useDapper | default: `false`<br/>values: `false`,`true` | Yes | Enables Dapper as a thin wrapper for the generated code. For more information, please refer to the [Dapper documentation](https://github.com/DapperLib/Dapper). |
1717

1818
### Configuration
1919
```yaml

0 commit comments

Comments
 (0)