README.md

<!--
SPDX-FileCopyrightText: 2024 Łukasz Niemier <#@hauleth.dev>

SPDX-License-Identifier: MPL-2.0
-->

# Aww

Generate URL for avatars using:

- [Gravatar](https://gravatar.com)
- [Libravatar](https://libravatar.org)

## Installation

```elixir
def deps do
  [
    {:aww, "~> 1.0"}
  ]
end
```

## Usage

Just pass the e-mail (or, in case of Libravatar, you can also use OpenID URL) to
the `Aww.avatar_url/1` function and you will receive `URI` struct which points
to avatar for given user.

```elixir
Aww.avatar_url("~@hauleth.dev")
# => %URI{
#   scheme: "https",
#   userinfo: nil,
#   host: "seccdn.libravatar.org",
#   port: nil,
#   path: "/avatar/ac3c4f9061d8e8252d03301685433aa8f943d4d6540caa232ccfb227b38aaa6c",
#   query: "",
#   fragment: nil
# }
```