Skip to content

Commit c5ab771

Browse files
authored
Fix linter issues with ReadMe (#84)
* Use an emoji for Contributors title Emoji Used: Champion Cup Aligns with the rest of the titles Why Champion Cup you ask? Well, Contributors are champions too! 😎 * Don't use inline HTML in markdown Always use markdown format if possible. This format to represent image with a link is supported by most markdown parsers. * Fix grammatical errors in markdown These were reported by Spell Checker extension (by EWSoftware) in VS IDE. * Use canonical language-agnostic URLs Microsoft Docs provide language-specific content for docs published to the website but in-order for devs in specific region to get locally translated content, we need to put language-agnostic canonical URLs. This is usually done by removing any language and region specific info from URLs. Reported by Docs markdown linter in VSCode.
1 parent f2cfa3a commit c5ab771

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@
99

1010
## 👀 What does this repo contain?
1111

12-
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:
12+
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:
1313

14-
- [`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.
14+
- [`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.
1515
- `CommunityToolkit.Mvvm.SourceGenerators`: the source generators to augment the MVVM Toolkit.
16-
- [`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.
17-
- [`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<T>` and `Span<T>` ([`Memory2D<T>`](https://docs.microsoft.com/en-us/windows/communitytoolkit/high-performance/memory2d) and [`Span2D<T>`](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.
18-
- [`CommunityToolkit.Common`](https://docs.microsoft.com/en-us/dotnet/api/?term=communitytoolkit.common): a set of helper APIs shared with other CommunityToolkit libraries.
16+
- [`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.
17+
- [`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<T>` and `Span<T>` ([`Memory2D<T>`](https://docs.microsoft.com/windows/communitytoolkit/high-performance/memory2d) and [`Span2D<T>`](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.
18+
- [`CommunityToolkit.Common`](https://docs.microsoft.com/dotnet/api/?term=communitytoolkit.common): a set of helper APIs shared with other CommunityToolkit libraries.
1919

2020
## 🙌 Getting Started
2121

@@ -48,10 +48,8 @@ For more information see the [.NET Foundation Code of Conduct](CODE_OF_CONDUCT.m
4848

4949
This project is supported by the [.NET Foundation](http://dotnetfoundation.org).
5050

51-
## Contributors
51+
## 🏆 Contributors
5252

53-
<a href="https://github.com/CommunityToolkit/dotnet/graphs/contributors">
54-
<img src="https://contrib.rocks/image?repo=CommunityToolkit/dotnet" />
55-
</a>
53+
[![Toolkit Contributors](https://contrib.rocks/image?repo=CommunityToolkit/dotnet)](https://github.com/CommunityToolkit/dotnet/graphs/contributors)
5654

5755
Made with [contrib.rocks](https://contrib.rocks).

0 commit comments

Comments
 (0)