Merge pull request #576 from marner2/feature/improve_documentation_re…

…adme

Improve documentation readme

README.md

@@ -3,7 +3,7 @@ WPF done the Elmish Way
 
 <img src="https://raw.githubusercontent.com/elmish/Elmish.WPF/master/logo/elmish-wpf-logo-ghreadme.png" width="300" align="right" />
 
-[![NuGet version](https://img.shields.io/nuget/v/Elmish.WPF.svg)](https://www.nuget.org/packages/Elmish.WPF) [![NuGet downloads](https://img.shields.io/nuget/dt/Elmish.WPF.svg)](https://www.nuget.org/packages/Elmish.WPF) [![Build status](https://github.com/elmish/Elmish.WPF/workflows/master/badge.svg)](https://github.com/elmish/Elmish.WPF/actions/workflows/master.yml)
+[![NuGet version](https://img.shields.io/nuget/v/Elmish.WPF.svg)](https://www.nuget.org/packages/Elmish.WPF) [![NuGet downloads](https://img.shields.io/nuget/dt/Elmish.WPF.svg)](https://www.nuget.org/packages/Elmish.WPF) [![Build status](https://github.com/elmish/Elmish.WPF/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/elmish/Elmish.WPF/actions/workflows/continuous_integration.yml)
 
 **The good parts of MVVM (the data bindings) with the simplicity and robustness of an MVU architecture for the rest of your app. Never write an overly-complex ViewModel class again!**
 
@@ -152,7 +152,17 @@ See the [SingleCounter](https://github.com/elmish/Elmish.WPF/tree/master/src/Sam
    open Elmish.WPF
 
    let main window =
-     Program.mkSimpleWpf init update bindings
+     Program.mkSimple init update bindings
+     |> Program.runElmishLoop window
+   ```
+
+   Alternatively, use a statically-typed view model at the top level.
+
+   ```F#
+   open Elmish.WPF
+
+   let main window =
+     Program.mkSimpleT init update CounterViewModel
      |> Program.runElmishLoop window
    ```
 
@@ -276,6 +286,29 @@ Then use the following attributes wherever you need a design-time VM:
 
 When targeting legacy .NET Framework, “Project code” must be enabled in the XAML designer for this to work.
 
+If you are using static view models, make sure that the View Model type is in a namespace and add a default constructor that passes a model into `ViewModelArgs.simple`:
+
+```F#
+namespace ViewModels
+
+type [<AllowNullLiteral>] AppViewModel (args) =
+  inherit ViewModelBase<AppModel, AppMsg>(args)
+  
+  new() = AppViewModel(App.init () |> ViewModelArgs.simple)
+```
+
+Then use the following attributes just like you would in a normal C# MVVM project:
+
+```XAML
+<Window
+    ...
+    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
+    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
+    xmlns:vm="clr-namespace:ViewModels.SubModelStatic;assembly=MyAssembly"
+    mc:Ignorable="d"
+    d:DataContext="{d:DesignInstance Type=vm:AppViewModel, IsDesignTimeCreatable=True}">
+```
+
 ##### .NET Core 3 workaround
 
 When targeting .NET Core 3, a bug in the XAML designer causes design-time data to not be displayed through `DataContext` bindings. See [this issue](https://developercommunity.visualstudio.com/content/problem/1133390/design-time-data-in-datacontext-binding-not-displa.html) for details. One workaround is to add a `d:DataContext` binding alongside your normal `DataContext` binding. Another workaround is to change

src/Elmish.WPF/Elmish.WPF.fsproj

@@ -12,14 +12,15 @@
     <PublishRepositoryUrl>true</PublishRepositoryUrl>
     <DebugType>Embedded</DebugType>
     <EmbedAllSources>True</EmbedAllSources>
-    <Authors>jsacks, cmeeren, TysonMN</Authors>
+    <Authors>jsacks, cmeeren, TysonMN, jmarner</Authors>
     <Description>F# bindings for using Elmish in WPF</Description>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/elmish/Elmish.WPF</PackageProjectUrl>
     <PackageTags>WPF F# fsharp Elmish Elm</PackageTags>
     <PackageIcon>elmish-wpf-logo-128x128.png</PackageIcon>
     <Version>4.0.0-beta-53</Version>
     <PackageReleaseNotes>https://github.com/elmish/Elmish.WPF/blob/master/RELEASE_NOTES.md</PackageReleaseNotes>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
     <!--Turn on warnings for unused values (arguments and let bindings) -->
     <OtherFlags>$(OtherFlags) --warnon:1182</OtherFlags>
   </PropertyGroup>
@@ -29,6 +30,7 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <None Include="..\..\README.md" Link="README.md" Pack="True" PackagePath="/" />
     <None Include="elmish-wpf-logo-128x128.png">
       <Pack>True</Pack>
       <PackagePath></PackagePath>