Merge pull request #7 from mgomar/master

Update readme, added PRISM and Xaml Islands
microsoft · Feb 9, 2019 · 520e246 · 520e246
2 parents e827567 + 2b94884
commit 520e246
Showing 1 changed file with 44 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -8,6 +8,10 @@ We have added an ARM template so you can automate the creation of the resources
 
 <a href="https://portal.azure.com/#create/Microsoft.Template/uri/https%3A%2F%2Fraw.githubusercontent.com%2FMicrosoft%2FTailwindTraders-Desktop%2Fmaster%2FDeploy%2Fdeployment.json"><img src="/Documents/Images/deploy-to-azure.png" alt="Deploy to Azure"/></a>
 
+| DevOps | master                                                       | 
+| ----------------- | ------------------------------------------------------------ |
+| Windows           | [![Build status](https://dev.azure.com/tailwindtraders/Desktop/_apis/build/status/Desktop-.NET%20Desktop-CI)](https://dev.azure.com/tailwindtraders/Desktop/_build/latest?definitionId=4) |
+
 # Repositories
 
 For this demo reference, we built several consumer and line-of-business applications and a set of backend services. You can find all repositories in the following locations:
@@ -19,6 +23,35 @@ For this demo reference, we built several consumer and line-of-business applicat
 * [Rewards (ASP.NET Framework)](https://github.com/Microsoft/TailwindTraders-Rewards)
 * [Mobile (Xamarin Forms 4.0)](https://github.com/Microsoft/TailwindTraders-Mobile)
 
+# Architecture
+
+We use Package references, manage NuGet dependencies directly within project files (as opposed to a separate packages.config file)
+
+## PRISM
+Prism is a framework for building loosely coupled, maintainable, and testable XAML applications in WPF, Windows 10 UWP, and Xamarin Forms.
+
+Official Prism releases are available on NuGet. Simply add https://www.myget.org/F/prism/api/v3/index.json as a package source to either Visual Studio or Visual Studio for Mac.
+
+These are the base packages for each platform, together with the Prism's Core assembly as a cross-platform PCL.
+
+| Platform | Assembly | Package | NuGet |
+| -------- | -------- | ------- | ------- | ----- |
+| PCL | Prism.dll | [Prism.Core][CoreNuGet] | [![CoreNuGetShield]][CoreNuGet] | [![CoreMyGetShield]][CoreMyGet] |
+| WPF | Prism.Wpf.dll | [Prism.Wpf][WpfNuGet] | [![WpfNuGetShield]][WpfNuGet] |
+| DryIoc | Prism.DryIoc.dll | [Prism.DryIoc][DryIocWpfNuGet] | [![DryIocWpfNuGetShield]][DryIocWpfNuGet] |
+
+## Xaml Islands
+There are two new system APIs called [WindowsXamlManager](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.hosting.windowsxamlmanager) and [DesktopWindowXamlSource](https://docs.microsoft.com/en-us/uwp/api/windows.ui.xaml.hosting.desktopwindowxamlsource).
+
+The WindowsXamlManager handles the UWP XAML Framework itself, which initializes the UWP XAML Framework inside the current thread of this non-UWP Win32 Desktop app, allowing it to create UWP UI in it.
+
+The DesktopWindowXamlSource is the actual instance of your Island content. This class also enables the developer to get and set the focus of that element.
+
+| NuGet | Description |
+| ------------------------------------- | ------------------------------------------------------------------------- |
+| [Microsoft.Toolkit.Wpf.UI.XamlHost](https://www.nuget.org/packages/Microsoft.Toolkit.Wpf.UI.XamlHost/) |
+|[Microsoft.Toolkit.Wpf.UI.Controls](https://www.nuget.org/packages/Microsoft.Toolkit.Wpf.UI.Controls/) | Wrapper classes for 1st party controls, InkCanvas, InkToolbar, MapControl, MediaPlayerElement, all for WPF. |
+
 # Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
@@ -31,4 +64,14 @@ provided by the bot. You will only need to do this once across all repos using o
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
-contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+
+[CoreNuGet]: https://www.nuget.org/packages/Prism.Core/
+[WpfNuGet]: https://www.nuget.org/packages/Prism.Wpf/
+[CoreNuGetShield]: https://img.shields.io/nuget/vpre/Prism.Core.svg
+[WpfNuGetShield]: https://img.shields.io/nuget/vpre/Prism.Wpf.svg
+[DryIocWpfNuGetShield]: https://img.shields.io/nuget/vpre/Prism.DryIoc.svg
+[CoreMyGetShield]: https://img.shields.io/myget/prism/vpre/Prism.Core.svg
+[DryIocWpfMyGetShield]: https://img.shields.io/myget/prism/vpre/Prism.DryIoc.svg
+[DryIocWpfNuGet]: https://www.nuget.org/packages/Prism.DryIoc/