Skip to content

Repository files navigation

GitHub license Maven Central Version Kotlin Kotlin Multiplatform

badge-android badge-ios badge-desktop badge-js

Gravatar Multiplatform

This library for set up for Kotlin Multiplatform (KMP)

This is a Kotlin Multiplatform compatible library for accessing Gravatar resources.

Generating an avatar image URL does not require any additional, but if you need to use the Gravatar REST API you will need to make sure Ktor runs properly in your project.

Feel free to fork it and make improvements, I'll keep up as best I can.

Features

...describe features...

Installation

Maven Central Version

Add the dependency to tyour library file:

[versions]
aughtone-gravatar = "${version}"

[libraries]
aughtone-gravatar = { module = "io.github.aughtone:gravatar", version.ref = "aughtone-gravatar" }

Include the dependency in the module you want to use it with:

implementation(libs.aughtone.gravatar)

Or if you are still old-school:

implementation("io.github.aughtone:gravatar:${version}")

Quick Start

You can get a simple Gravatar url like this:

val avatarUrl: String = gravatarUrl(email = "johndoe@example.com", name = "John Doe")

The name property will be used to generate an initials image if no Gravatar is found, so you get an output like the one with the initials, since that address is not registered with Gravatar:

image image

Feedback

Bugs can go into the issue tracker, but you are probably going to get faster support by creating a PR.


🤖 AI-Assisted Development

This library includes embedded, machine-readable "skills" to enhance the experience of developers using AI code assistants. These skills help the AI understand our library's APIs and best practices, leading to more accurate and idiomatic code suggestions.

  • AI Skill Discovery: Look for META-INF/ai-skills/*.ai-skill.md

To learn how to add this capability to your own library, see our AI Skill Publishing Standard.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages