Skip to content

Commit

Permalink
Merge pull request #1245 from ably/update/readme-maui
Browse files Browse the repository at this point in the history
MAUI config doc
  • Loading branch information
sacOO7 authored Jul 5, 2023
2 parents 701efbf + 7bc29b8 commit 06111d7
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This is a .NET client library for Ably. The library currently targets the [Ably
## Supported platforms

* [.NET Standard 2.0+](https://learn.microsoft.com/en-us/dotnet/standard/net-standard?tabs=net-standard-2-0)
* .NET 6.x, 7.x (MAUI supported)
* .NET 6.x, 7.x, MAUI, check [MAUI config](#maui-configuration).
* .NET Framework 4.6.2+
* .NET (Core) 2.0+
* Mono 5.4+
Expand Down Expand Up @@ -446,6 +446,18 @@ options.TransportFactory = new MsWebSocketTransport.TransportFactory(websocketOp
var realtime = new AblyRealtime(options);
```

### MAUI configuration
- Since `ably-dotnet` makes use of the reflection API, MAUI assembly trimming may cause issues.
- When using MAUI, we recommend adding the following to your `.csproj` file to disable assembly trimming.

```xml
<ItemGroup>
<TrimmerRootAssembly Include="IO.Ably" />
</ItemGroup>
```
- For more information related to assembly trimming, check [MAUI trimming doc](https://learn.microsoft.com/en-us/dotnet/core/deploying/trimming/trimming-options).


### Examples

* More Examples can be found under ```examples``` directory.
Expand Down

0 comments on commit 06111d7

Please sign in to comment.