Skip to content

Commit 38f6494

Browse files
authored
Update README (#263)
1 parent a8ecbee commit 38f6494

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ This documentation covers using ReactiveUI Source Generators to simplify and enh
77
- **Visual Studio Version**: 17.8.0
88
- **ReactiveUI Version**: 19.5.31+
99

10+
## Table of Contents
11+
- [Overview](#overview)
12+
- [Supported Attributes & Features](#supported-attributes)
13+
- [Detailed Usage](#welcome-to-a-new-way---source-generators)
14+
- [Reactive](#reactive)
15+
- [ObservableAsProperty](#observableasproperty)
16+
- [ReactiveCommand](#reactivecommand)
17+
- [IViewFor](#iviewfor)
18+
- [BindableDerivedList](#usage-readonlyobservablecollection)
19+
- [Platform-Specific Attributes](#platform-specific-attributes)
20+
- [Compatibility Notes](#compatibility-notes)
21+
- [Credits](#credits)
22+
1023
## Overview
1124

1225
ReactiveUI Source Generators automatically generate ReactiveUI objects to streamline your code. These Source Generators are designed to work with ReactiveUI V19.5.31+ and support the following features:
@@ -330,7 +343,7 @@ public partial class MyReactiveClass : ReactiveObject
330343
}
331344

332345
[ObservableAsProperty(InitialValue = "Default Value")]
333-
public string MyProperty { get; }
346+
public partial string MyProperty { get; }
334347

335348
public IObservable<string> MyPropertyObservable() => Observable.Return("Test Value");
336349
}
@@ -371,7 +384,10 @@ public partial class MyReactiveClass
371384
}
372385
```
373386

374-
### Usage ReactiveCommand with parameter and async return value
387+
### Usage ReactiveCommand with parameter and async return value.
388+
389+
Note: the Async suffix is removed from the generated command
390+
375391
```csharp
376392
using ReactiveUI.SourceGenerators;
377393

0 commit comments

Comments
 (0)