diff --git a/README.md b/README.md index a0312451..ec59d633 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,13 @@ ## 👀 What does this repo contain? -This repository contains several .NET libraries (originally developed as part of the [Windows Community Toolkit](https://github.com/CommunityToolkit/WindowsCommunityToolkit)) that can be used both by application developers (regardless on the specific UI framework in use, they work everywhere!) as well as library authors. These libraries are also being used internally at Microsoft to power many of our first party apps (such as the new Microsoft Store) and constantly improved by listening to feedbacks from other teams, external partners and other developers from the community. Here's a quick breakdown of the various components you'll find in this repository: +This repository contains several .NET libraries (originally developed as part of the [Windows Community Toolkit](https://github.com/CommunityToolkit/WindowsCommunityToolkit)) that can be used both by application developers (regardless on the specific UI framework in use, they work everywhere!) and library authors. These libraries are also being used internally at Microsoft to power many of our first party apps (such as the new Microsoft Store) and constantly improved by listening to feedbacks from other teams, external partners and other developers from the community. Here's a quick breakdown of the various components you'll find in this repository: -- [`CommunityToolkit.Mvvm` (aka MVVM Toolkit)](https://docs.microsoft.com/en-us/windows/communitytoolkit/mvvm/introduction): a fast, modular, platform agnostic MVVM library, which is the official successor of `MvvmLight`. It's used extensively in the Microsoft Store and other first party apps. +- [`CommunityToolkit.Mvvm` (aka MVVM Toolkit)](https://docs.microsoft.com/windows/communitytoolkit/mvvm/introduction): a fast, modular, platform-agnostic MVVM library, which is the official successor of `MvvmLight`. It's used extensively in the Microsoft Store and other first party apps. - `CommunityToolkit.Mvvm.SourceGenerators`: the source generators to augment the MVVM Toolkit. -- [`CommunityToolkit.Diagnostics`](https://docs.microsoft.com/en-us/windows/communitytoolkit/diagnostics/introduction): a set of helper APIs (specifically, [`Guard`](https://docs.microsoft.com/en-us/windows/communitytoolkit/developer-tools/guard) and [`ThrowHelper`](https://docs.microsoft.com/en-us/windows/communitytoolkit/developer-tools/throwhelper)) that can be used for cleaner, more efficient and less error prone argument validation and error checking. -- [`CommunityToolkit.HighPerformance`](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/introduction) a collection of helpers for working in high-performance scenarios. It includes APIs such as [pooled buffer helpers](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/memoryowner), a fast [string pool](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/stringpool) type, a 2D variant of `Memory` and `Span` ([`Memory2D`](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/memory2d) and [`Span2D`](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/span2d)) also supporting discontiguous regions, helpers for bit shift operations (such as [`BitHelper`](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/span2d), also used in [Paint.NET](https://www.getpaint.net/)), and more. -- [`CommunityToolkit.Common`](https://docs.microsoft.com/en-us/dotnet/api/?term=communitytoolkit.common): a set of helper APIs shared with other CommunityToolkit libraries. +- [`CommunityToolkit.Diagnostics`](https://docs.microsoft.com/windows/communitytoolkit/diagnostics/introduction): a set of helper APIs (specifically, [`Guard`](https://docs.microsoft.com/windows/communitytoolkit/developer-tools/guard) and [`ThrowHelper`](https://docs.microsoft.com/windows/communitytoolkit/developer-tools/throwhelper)) that can be used for cleaner, more efficient and less error-prone argument validation and error checking. +- [`CommunityToolkit.HighPerformance`](https://docs.microsoft.com/windows/communitytoolkit/high-performance/introduction) a collection of helpers for working in high-performance scenarios. It includes APIs such as [pooled buffer helpers](https://docs.microsoft.com/windows/communitytoolkit/high-performance/memoryowner), a fast [string pool](https://docs.microsoft.com/windows/communitytoolkit/high-performance/stringpool) type, a 2D variant of `Memory` and `Span` ([`Memory2D`](https://docs.microsoft.com/windows/communitytoolkit/high-performance/memory2d) and [`Span2D`](https://docs.microsoft.com/windows/communitytoolkit/high-performance/span2d)) also supporting discontiguous regions, helpers for bit shift operations (such as [`BitHelper`](https://docs.microsoft.com/windows/communitytoolkit/high-performance/span2d), also used in [Paint.NET](https://www.getpaint.net/)), and more. +- [`CommunityToolkit.Common`](https://docs.microsoft.com/dotnet/api/?term=communitytoolkit.common): a set of helper APIs shared with other CommunityToolkit libraries. ## 🙌 Getting Started @@ -48,10 +48,8 @@ For more information see the [.NET Foundation Code of Conduct](CODE_OF_CONDUCT.m This project is supported by the [.NET Foundation](http://dotnetfoundation.org). -## Contributors +## 🏆 Contributors - - - +[![Toolkit Contributors](https://contrib.rocks/image?repo=CommunityToolkit/dotnet)](https://github.com/CommunityToolkit/dotnet/graphs/contributors) Made with [contrib.rocks](https://contrib.rocks).