Skip to content

Adds installation instructions to README #2797

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 8, 2025
Merged

Adds installation instructions to README #2797

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d816da
Adds installation instructions to README
VladislavAntonyuk Jul 8, 2025
8236d2e
Update README.md
VladislavAntonyuk Jul 8, 2025
76f0853
Update README.md
VladislavAntonyuk Jul 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,32 @@ All of the [documentation](https://learn.microsoft.com/dotnet/communitytoolkit/m

https://learn.microsoft.com/dotnet/communitytoolkit/maui/get-started

## Installation

The release versions of .NET MAUI Community Toolkit are available at Nuget.org as NuGet packages. You can install them using the following commands in your terminal or Package Manager Console:

```bash
dotnet add package CommunityToolkit.Maui
dotnet add package CommunityToolkit.Maui.MediaElement
dotnet add package CommunityToolkit.Maui.Maps
dotnet add package CommunityToolkit.Maui.Camera
```

You can also try the latest pre-release version of the main branch. We use GitHub Packages to host the pre-release versions of the .NET MAUI Community Toolkit. To install the pre-release version, you need to add the GitHub Packages source to your NuGet configuration. GitHub Packages only supports authentication using a personal access token (classic) (https://github.com/settings/tokens). For more information, see [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). You can use a personal access token (classic) to authenticate to GitHub Packages. When you create a personal access token (classic), you can assign the token different scopes depending on your needs, but `read:packages` is enough.

```bash
dotnet nuget add source https://nuget.pkg.github.com/CommunityToolkit/index.json -n CommunityToolkitGitHubNuget -u YOUR_GITHUB_USERNAME -p YOUR_GITHUB_PERSONAL_ACCESS_TOKEN
```

and then install the packages as follows:

```bash
dotnet add package CommunityToolkit.Maui --version 99.0.0-preview980
dotnet add package CommunityToolkit.Maui.MediaElement --version 99.0.0-preview980
dotnet add package CommunityToolkit.Maui.Maps --version 99.0.0-preview980
dotnet add package CommunityToolkit.Maui.Camera --version 99.0.0-preview980
```

## Getting Started

In order to use the .NET MAUI Community Toolkit you need to call the extension method in your `MauiProgram.cs` file as follows:
Expand Down
Loading