Gravatar-Android

The Gravatar Android SDK is a library that provides a set of UI components and utilities to fetch and display Gravatar images and profile data in Android applications.

If you're also looking to integrate Gravatar in your iOS app, check out our Gravatar SDK for iOS!

Features

• Ready-to-use asynchronous services for Gravatar REST API based on Kotlin Coroutines.
• Avatar URL calculator based on email and several query options.
• Display a profile view or an avatar through ready-to-use Jetpack Compose UI components.
• QuickEditor: This customizable sheet allows you to manage your avatar and Gravatar profile. You can select an existing avatar or upload a new one, and it provides a summary of your Gravatar profile.

Installation

To add the Gravatar SDK to your project, you can use the following Gradle dependency:

dependencies {
    implementation("com.gravatar:gravatar:<version>")
    // OR
    implementation("com.gravatar:gravatar-ui:<version>")
    // OR
    implementation("com.gravatar:gravatar-quickeditor:<version>")
}

Additionally, if you're using version 2.3.1 or older of the SDK, you need to add custom Gradle repository:

repositories {
    maven {
        url = uri("https://a8c-libs.s3.amazonaws.com/android")
    }
}

For further details on how to integrate in your own app please take a look at our Get Started guide. You'll find a quick overview of how to get an API key and use the library in your projects.

Documentation

You can find the full API documentation here.

For Maintainers

If you're contributing to or maintaining this project, check out SDK's technical details.

Contributing

Read our Contributing Guide to learn about reporting issues, contributing code, and more ways to contribute.

License

Gravatar-SDK-Android is an open source project covered by the Mozilla Public License Version 2.0.