Skip to content

Commit

Permalink
doco
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Mar 24, 2019
1 parent bb7214d commit 35a4a8a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<Project>
<PropertyGroup>
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<Version>3.1.0-beta.2</Version>
<Version>3.1.0</Version>
<LangVersion>latest</LangVersion>
<NoWarn>NU5118</NoWarn>
</PropertyGroup>
Expand Down
11 changes: 9 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The `Install-Package Fody` is required since NuGet always defaults to the oldest

## How to use it

By default, `ConfigureAwait.Fody` doesn't change any of your code. You have to explicitly set a configure await value at the assembly, class, or method level.
By default, `ConfigureAwait.Fody` doesn't change any code. Set a configure await value at the assembly, class, or method level.

* `[assembly: Fody.ConfigureAwait(false)]` - Assembly level
* `[Fody.ConfigureAwait(false)]` - Class or method level
Expand All @@ -31,12 +31,19 @@ By default, `ConfigureAwait.Fody` doesn't change any of your code. You have to e
Add `<ConfigureAwait/>` to [FodyWeavers.xml](https://github.com/Fody/Home/blob/master/pages/usage.md#add-fodyweaversxml)

```xml
<?xml version="1.0" encoding="utf-8" ?>
<Weavers>
<ConfigureAwait/>
</Weavers>
```

It is also possible set the default ContinueOnCapturedContext in the xml config:

```xml
<Weavers>
<ConfigureAwait ContinueOnCapturedContext="false" />
</Weavers>
```


## Example

Expand Down

0 comments on commit 35a4a8a

Please sign in to comment.