AndroidX/README.md

# Third Party Library Bindings for .NET for Android

[![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/xamarin/AndroidX/blob/main/LICENSE.txt)
[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/xamarin/AndroidX/issues)
[![GitHub contributors](https://img.shields.io/github/contributors/xamarin/AndroidX.svg)](https://github.com/xamarin/AndroidX/graphs/contributors)

Microsoft creates and maintains .NET for Android bindings for many of Google's Java/Kotlin 
Android libraries and their required third-party dependency libraries, such as:

- [AndroidX](https://developer.android.com/jetpack) ([Google Release Notes](https://developer.android.com/jetpack/androidx/versions/stable-channel))
- [Google Play Services](https://developers.google.com/android) ([Google Release Notes](https://developers.google.com/android/guides/releases))
- [Firebase](https://firebase.google.com) ([Google Release Notes](https://firebase.google.com/support/release-notes/android))
- [ML Kit](https://developers.google.com/ml-kit) ([Google Release Notes](https://developers.google.com/ml-kit/release-notes))

Note that support for Xamarin.Android ended on [May 1st, 2024](https://dotnet.microsoft.com/en-us/platform/support/policy/xamarin). New versions of these packages will only support .NET for Android.

## Binding Policies

- This repository binds over 600 Android libraries that are published to [NuGet.org](https://nuget.org). The full 
  package list can be found in [config.json](config.json).
- Most Google Java/Kotlin artifacts and some dependencies come from [Google's Maven Respository](https://maven.google.com/web/index.html#).
- Additional dependencies come from [Maven/Sonatype Central](https://repo1.maven.org/maven2/).
- The major/minor/patch version numbers mirror the bound Android library version. For example, the NuGet `Xamarin.AndroidX.Core 1.3.2.1` 
  binds version `1.3.2` of the AndroidX library `androidx.core:core`.
  - The revision version number is used when a new NuGet needs to be built but the Android library has not been updated.
- We endeavor to release updated NuGets within a few weeks after new Android releases, however large changes occasionally require 
  more time.
- In general, we do not bind pre-release libraries. As their API is not stable yet, it results in too much rework. Additionally,
  it can result in stable NuGet packages depending on unstable NuGet packages.

### Details

Full list of maven artifact to NuGet mappings:

[./docs/artifact-list.md](./docs/artifact-list.md)

Full list of maven artifact with versions to NuGet mappings with versions:

[./docs/artifact-list-with-versions.md](./docs/artifact-list-with-versions.md)

## Support

Note that these packages are largely just autogenerated bindings around Google's Android libraries.  As such, our support is limited to issues caused by our bindings.  For tutorials/samples/support using the libraries themselves, please refer to [Google's documentation](https://developer.android.com/jetpack).

## License

The license for this repository is specified in [LICENSE.txt](LICENSE.txt).

Each package published from this repository generally contains third-party code (ie: `.jar`/`.aar`) that 
is governed by its own license.  Per-package license information is available in [cgmanifest.json](cgmanifest.json).

## Building

Instructions for building this repository are specified in [BUILDING.md](BUILDING.md).

In depth building instructions: [./docs/build.md](./docs/build.md).

## Contribution Guidelines

The Contribution Guidelines for this repository are listed in [CONTRIBUTING.md](.github/CONTRIBUTING.md).

This project has adopted the code of conduct defined by the Contributor Covenant
to clarify expected behavior in our community. For more information, see the
[.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).

## .NET Foundation

This project is part of the [.NET Foundation](http://www.dotnetfoundation.org/projects).