Skip to content

Commit 890e014

Browse files
committed
Improve README
1 parent 5cbcb3c commit 890e014

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,16 @@
11
# Sync Method Generator
22

3+
![Type less, sync more, star!](https://img.shields.io/badge/Type_less-Sync_more-purple)
34
[![Build](https://github.com/zompinc/sync-method-generator/actions/workflows/build.yml/badge.svg)](https://github.com/zompinc/sync-method-generator/actions/workflows/build.yml)
45
![Support .NET Standard 2.0](https://img.shields.io/badge/dotnet%20version-.NET%20Standard%202.0-blue)
56
[![Nuget](https://img.shields.io/nuget/v/Zomp.SyncMethodGenerator)](https://www.nuget.org/packages/Zomp.SyncMethodGenerator)
67
[![codecov](https://codecov.io/gh/zompinc/sync-method-generator/branch/master/graph/badge.svg)](https://codecov.io/gh/zompinc/sync-method-generator)
8+
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/zompinc/sync-method-generator)
79

810
This [.NET source generator](https://learn.microsoft.com/en-us/dotnet/csharp/roslyn-sdk/source-generators-overview) produces a sync method from an async one.
911

12+
If you hate code duplication or calling async methods from sync please [⭐ star this project](https://github.com/zompinc/sync-method-generator/stargazers)
13+
1014
## Use cases
1115

1216
- A library which exposes both sync and async version of a method
@@ -131,6 +135,11 @@ If you only want to execute in the original async version, flip the flag like th
131135

132136
Note: `SYNC_ONLY` cannot be mixed with other symbols in a conditional expression and cannot have `#elif` directive.
133137

138+
> [!WARNING]
139+
> `SYNC_ONLY` flag currently works in parameter lists, argument lists and statements.
140+
> Please always double check your code when using this flag.
141+
> If your use case is not supported, please log an issue.
142+
134143
## Installation
135144

136145
To add the library use:

0 commit comments

Comments
 (0)