Skip to content

Commit 8963a87

Browse files
Update readme with latest info from 8.0 release.
1 parent b27ef3b commit 8963a87

File tree

1 file changed

+25
-10
lines changed

1 file changed

+25
-10
lines changed

README.md

+25-10
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,46 @@
1-
# Windows Community Toolkit
2-
This new "MVVM Toolkit" is part of the [Windows Community Toolkit](https://aka.ms/wct). The Windows Community Toolkit is part of the [.NET Foundation](https://dotnetfoundation.org/).
1+
# .NET Community Toolkit
2+
This new "MVVM Toolkit" is part of the [.NET Community Toolkit](https://aka.ms/toolkit/dotnet). The .NET Community Toolkit is part of the [.NET Foundation](https://dotnetfoundation.org/).
3+
4+
<a style="text-decoration:none" href="https://aka.ms/mvvmtoolkit/app" target="_blank">
5+
<img src="https://img.shields.io/badge/Microsoft%20Store-Download-brightgreen" alt="Store link" />
6+
</a>
7+
8+
<a style="text-decoration:none" href="https://nuget.org/packages/CommunityToolkit.Mvvm" target="_blank">
9+
<img src="https://img.shields.io/nuget/dt/CommunityToolkit.Mvvm" alt="NuGet Downloads" />
10+
</a>
11+
12+
![image](https://user-images.githubusercontent.com/24302614/185499041-1e17df3e-8246-4c4e-a450-c6488dcd23ea.png)
313

414
# MVVM Toolkit & Samples
515

6-
The MVVM library of the Windows Community Toolkit can be found in the [`Microsoft.Toolkit.Mvvm` NuGet package](https://www.nuget.org/packages/Microsoft.Toolkit.Mvvm). It will be known as the "MVVM Toolkit" in short for reference.
16+
The MVVM library of the .NET Community Toolkit can be found in the [`CommunityToolkit.Mvvm` NuGet package](https://www.nuget.org/packages/CommunityToolkit.Mvvm). It will be known as the "MVVM Toolkit" in short for reference.
717

8-
The full official documentation can be found [in MS Docs website](https://docs.microsoft.com/en-us/windows/communitytoolkit/mvvm/introduction).
18+
The full official documentation can be found [in MS Docs website](https://aka.ms/mvvmtoolkit/docs).
919

10-
This repo contains initial samples for how to utilize the library.
20+
This repo contains initial samples for how to utilize the library as part of our sample app itself. You can download [the sample app in the Microsoft Store here](https://aka.ms/mvvmtoolkit/app).
21+
22+
[![image](https://user-images.githubusercontent.com/24302614/185500042-5240bcc8-3d61-49c6-85c8-b0ab681cdb7a.png)](https://aka.ms/mvvmtoolkit/app)
1123

1224
## Introduction to the MVVM Toolkit
1325

14-
The `Microsoft.Toolkit.Mvvm` package is a modern, fast, and modular MVVM library. It is built around the following principles:
26+
The `CommunityToolkit.Mvvm` package is a modern, fast, and modular MVVM library. It is built around the following principles:
1527

1628
- **Platform and Runtime Independent** - **.NET Standard 2.x** 🚀 (UI Framework Agnostic)
1729
- **Simple to pick-up and use** - No strict requirements on Application structure or coding-paradigms (outside of 'MVVM'ness), i.e., flexible usage.
1830
- **À la carte** - Freedom to choose which components to use.
1931
- **Reference Implementation** - Lean and performant, providing implementations for interfaces that are included in the Base Class Library, but lack concrete types to use them directly.
2032

21-
The package targets .NET Standard so it can be used on any app platform: UWP, WinForms, WPF, Xamarin, Uno, and more; and on any runtime: .NET Native, .NET Core, .NET Framework, or Mono. It runs on all of them. The API surface is identical in all cases.
33+
The package targets .NET Standard so it can be used on any app platform: UWP, WinForms, WPF, Xamarin, Uno, and more; and on any runtime: .NET Native, .NET Core, .NET Framework, or Mono. It runs on all of them. The API surface is identical in all cases. When running on newer runtimes, like .NET 6, it is still optimized to take advantadge of those platforms for the best performance.
34+
35+
[You can read more about the latest features in the release blog here.](https://devblogs.microsoft.com/dotnet/announcing-the-dotnet-community-toolkit-800/)
2236

2337
## Background
38+
2439
This library was inspired by [MVVMLight](https://www.mvvmlight.net/) by Laurent Bugnion. Development was started in April 2020 as a path forward for developers using MVVMLight. We've worked with Laurent, the community, and [Windows Template Studio](https://aka.ms/wts) to ensure successful migration paths for projects using MVVMLight today.
2540

2641
We decided to start from the ground-up as a new project to architect a modern .NET Standard starting point as well as targeting a high-performance implementation which reduces overhead for memory and CPU cycles. Many things in the .NET ecosystem have evolved and changed since the time MVVMLight had begun.
2742

28-
The Windows Community Toolkit seemed like a good home for this new library. This enables it to have broad support from the community, backing from the .NET Foundation, and longevity for the future.
43+
The Windows Community Toolkit seemed like a good home for this new library. This enables it to have broad support from the community, backing from the .NET Foundation, and longevity for the future. It has since spun off into being a major part of the .NET Community Toolkit.
2944

3045
We intend this library to be feature-complete and provide a common basis for app developers to create shared .NET Standard code in their applications for building with the MVVM pattern.
3146

@@ -37,11 +52,11 @@ It is not our intent to add or support platform-specific features. We encourage
3752

3853
## Contributing
3954

40-
If you find an issue with our docs or have suggestions, please file an issue in this repo for now, until our final release, when we will migrate to our main documentation repo.
55+
If you find an issue with our docs or have suggestions, please check [the latest documentation](https://aka.ms/mvvmtoolkit/docs) and file an issue on the docs repository.
4156

4257
If you'd like to help us with a sample for your own platform, please file an issue here and open up a dialog, or respond to one of the existing open issues tracking known platforms.
4358

44-
We do encourage suggestions, contributions, or platform-agnostic feature requests as well. Please open an issue to start that discussion on the [main repo here](https://github.com/windows-toolkit/WindowsCommunityToolkit).
59+
We do encourage suggestions, contributions, or platform-agnostic feature requests as well. Please open an issue to start that discussion on the [main repo here](https://github.com/CommunityToolkit/dotnet).
4560

4661
## License
4762

0 commit comments

Comments
 (0)