migration

README.md

@@ -1,3 +1,122 @@
-# SimpleToolkit.MVVM
+<p align="center"><img src=".gitea/readme/icon.png"/></p>
 
-Set of helpers, class extensions, UI controls used in my other C# projects - MVVM architecture models and helper classes
+<h1 align="center">SimpleToolkit.MVVM</h1>
+
+<h3 align="center"><b>Set of helpers, class extensions, UI controls used in my other C# projects</b></h3>
+
+<p align="center">SimpleToolkit is package of useful classes, helpers, extensions and UI controls, I use in my C# projects. MVVM subpackage contains models and helper classes for implementing MVVM architecture.</p>
+
+---
+
+## NuGet registry status
+
+<table>
+    <tr>
+        <th>
+            Subpackage
+        </th>
+        <th>
+            Status
+        </th>
+    </tr>
+    <tr>
+        <td>
+            <b>SimpleToolkit.MVVM</b>
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.MVVM/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.MVVM.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <th colspan=2>
+            Other subpackages
+        </th>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.Extensions
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.Extensions/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.Extensions.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.Attributes
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.Attributes/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.Attributes.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.UI.Models
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.UI.Models/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.UI.Models.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.UI.WinUI.Behaviors
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.UI.WinUI.Behaviors/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.UI.WinUI.Behaviors.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.UI.WinUI.Converters
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.UI.WinUI.Converters/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.UI.WinUI.Converters.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.UI.WinUI.Controls
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.UI.WinUI.Controls/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.UI.WinUI.Controls.svg?style=flat-square"></a>
+        </td>
+    </tr>
+    <tr>
+        <td>
+            SimpleToolkit.UI.WinUI.Helpers
+        </td>
+        <td>
+            <a href="https://www.nuget.org/packages/SimpleToolkit.UI.WinUI.Helpers/"><img src="https://img.shields.io/nuget/v/SimpleToolkit.UI.WinUI.Helpers.svg?style=flat-square"></a>
+        </td>
+    </tr>
+</table>
+
+## Features
+
+- **ObservableKeyValuePair** - observable version of KeyValuePair
+- **ObservableDictionary** - observable version of Dictionary
+
+## Installation and usage
+
+You can download package from official NuGet registry or .nupkg file itself from Releases tab.
+
+**CLI:**
+
+```
+dotnet add package SimpleToolkit.MVVM
+```
+
+**Package reference in .csproj file:**
+
+```
+<PackageReference Include="SimpleToolkit.MVVM" Version="<version>" />
+```
+
+## Attribution and contribution
+
+This project is open source on MIT License, so you can just copy and upload again to your repository. But according to the license, you must include information about the original author. You can find license <a href="https://repos.mateuszskoczek.com/SimpleToolkit/SimpleToolkit.MVVM/src/branch/main/LICENSE">here</a>.
+
+However, the preferred way to contribute would be to propose improvements in a pull request, through issues, or through other means of communication.
+
+**Other sources:**
+
+- Icon by <a href="icons8.com">Icons8</a>