Skip to content

Commit a5ea89a

Browse files
Include readme.txt and repo readme details (#27)
* Include readme.txt and repo readme details * Add using to example * Add using to example * Update ReadMe.txt Co-authored-by: Brandon Minnick <[email protected]>
1 parent 8ee783a commit a5ea89a

File tree

3 files changed

+45
-1
lines changed

3 files changed

+45
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,22 @@ All features are contributed by you, our amazing .NET community, and maintained
1212

1313
And – the best part – the features you add to the .NET MAUI Toolkit may one day be included into the official .NET MAUI library! We leverage the Community Toolkits to debut new features and work closely with the .NET MAUI engineering team to nominate features for promotion.
1414

15+
## Getting Started
16+
17+
In order to use the .NET MAUI Community Toolkit you need to call the extension method in your `MauiProgram.cs` file as follows:
18+
19+
```csharp
20+
using CommunityToolkit.Maui.Markup;
21+
22+
public static MauiApp CreateMauiApp()
23+
{
24+
var builder = MauiApp.CreateBuilder();
25+
// Initialise the toolkit
26+
builder.UseMauiApp<App>().UseMauiCommunityToolkitMarkup();
27+
// the rest of your logic...
28+
}
29+
```
30+
1531
## Submitting A New Feature
1632

1733
New features will follow the following steps:
@@ -55,4 +71,4 @@ Once a Pull Request has been reviewed + approved AND the documentation has been
5571
As a part of the .NET Foundation, we have adopted the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct). Please familiarize yourself with that before participating with this repository. Thanks!
5672

5773
## .NET Foundation
58-
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).
74+
This project is supported by the [.NET Foundation](https://dotnetfoundation.org).

src/CommunityToolkit.Maui.Markup/CommunityToolkit.Maui.Markup.csproj

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@
3636

3737
<ItemGroup>
3838
<None Include="icon.png" Pack="true" PackagePath="" />
39+
<None Include="ReadMe.txt" pack="true" PackagePath="." />
3940
</ItemGroup>
4041

4142
</Project>
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
.NET MAUI Community Toolkit
2+
3+
## Initializing
4+
5+
In order to use the .NET MAUI Community Toolkit you need to call the extension method in your `MauiProgram.cs` file as follows:
6+
7+
```csharp
8+
using CommunityToolkit.Maui.Markup;
9+
10+
public static MauiApp CreateMauiApp()
11+
{
12+
var builder = MauiApp.CreateBuilder();
13+
14+
// Initialise the toolkit
15+
builder.UseMauiApp<App>().UseMauiCommunityToolkitMarkup();
16+
17+
// the rest of your logic...
18+
}
19+
```
20+
21+
## Further information
22+
23+
For more information please visit:
24+
25+
- Our documentation site: https://docs.microsoft.com/dotnet/communitytoolkit/maui/markup/
26+
27+
- Our GitHub repository: https://github.com/CommunityToolkit/Maui.Markup

0 commit comments

Comments
 (0)