Skip to content

Commit 65c6993

Browse files
authored
Clarify a few documentation issues. (#1119)
Clarify a few documentation issues that have come up: - Ensure our package information explicitly lists MAUI, as that is the most likely project type users will have. - Port over the note about GPS package versions having a prepended "1" now that the repos are combined.
1 parent ee68132 commit 65c6993

File tree

3 files changed

+5
-2
lines changed

3 files changed

+5
-2
lines changed

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ Note that support for Xamarin.Android ended on [May 1st, 2024](https://dotnet.mi
2222
- Additional dependencies come from [Maven/Sonatype Central](https://repo1.maven.org/maven2/).
2323
- The major/minor/patch version numbers mirror the bound Android library version. For example, the NuGet `Xamarin.AndroidX.Core 1.3.2.1`
2424
binds version `1.3.2` of the AndroidX library `androidx.core:core`.
25+
- Note that some packages like `GooglePlayServices*` may prepend a "1" to the version number. For example, the NuGet
26+
`Xamarin.GooglePlayServices.Base 118.5.0` binds version `18.5.0` of the Java library.
27+
- Version and Java artifact information can be found in the NuGet readme ([example](https://www.nuget.org/packages/Xamarin.GooglePlayServices.Base/#readme-body-tab)).
2528
- The revision version number is used when a new NuGet needs to be built but the Android library has not been updated.
2629
- We endeavor to release updated NuGets within a few weeks after new Android releases, however large changes occasionally require
2730
more time.

source/AndroidXNuGetReadMe.cshtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
var licenses = string.Join("<br/>", Model.Licenses.Select(l => string.IsNullOrWhiteSpace(l.Url) ? new HtmlString(l.Name).Value : new HtmlString($"[{l.Name}]({l.Url})").Value).ToArray());
77
var developers = string.Join("<br/>", Model.Developers.Select(d => new HtmlString(d.Name).Value).ToArray());
88
}
9-
This package provides .NET for Android bindings for the Java library `@(Model.MavenGroupId):@(Model.Name)`.
9+
This package provides .NET for Android and MAUI bindings for the Java library `@(Model.MavenGroupId):@(Model.Name)`.
1010

1111
## Java Library
1212

source/AndroidXProject.cshtml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535
<!-- NuGet package properties -->
3636
<PropertyGroup>
3737
<PackageId>@(Model.NuGetPackageId)</PackageId>
38-
<Title>.NET for Android bindings for the Android Java library '@(Model.MavenGroupId):@(Model.Name)'.</Title>
38+
<Title>.NET for Android and MAUI bindings for the Android Java library '@(Model.MavenGroupId):@(Model.Name)'.</Title>
3939
<Description>
4040
$(Title)@(Model.NuGetPackageId.StartsWith("Xamarin.AndroidX.Compose") ? " Note this package only adds the Java library to the application. C# bindings are not provided." : string.Empty)
4141

0 commit comments

Comments
 (0)