@unavatar/core 3.19.5 → 3.19.7

package/README.md

@@ -68,15 +68,17 @@ It's proudly powered by [microlink.io](https://microlink.io/), the headless brow
 
 The service is exposed in **unavatar.io** via provider endpoints:
 
-- an **email**: [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)
+- an **email (auto-detect)**: [unavatar.io/hello@microlink.io](https://unavatar.io/hello@microlink.io) — tries Gravatar, then GitHub
+- an **email** via Gravatar: [unavatar.io/gravatar/hello@microlink.io](https://unavatar.io/gravatar/hello@microlink.io)
+- an **email** via GitHub: [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)
 - an **username**: [unavatar.io/github/kikobeats](https://unavatar.io/github/kikobeats)
 - a **domain**: [unavatar.io/google/reddit.com](https://unavatar.io/google/reddit.com)
 
-Use the `/:provider/:key` format for all lookups. You can read more about available providers in [providers](https://unavatar.io/docs#providers).
+Use `/:provider/:key` for provider-specific lookups, or pass an email as the only path segment for automatic resolution. You can read more in [Email avatars](https://unavatar.io/email) and [providers](https://unavatar.io/docs#providers).
 
 ## Authentication
 
-The anonymous requests works without authentication. They are limited to 25 requests/day per IP address.
+Anonymous requests work without authentication. They are limited to 25 requests/day per IP address.
 
 For [PRO](https://unavatar.io/checkout) users, the requests must include the API key as the `x-api-key` request header:
 
@@ -269,7 +271,7 @@ You can pass `fallback=false` to explicitly disable this behavior. In this case,
 
 The service returns media content by default.
 
-This is in this way to make easier consume the service from HTML markup.
+This makes the service easier to consume directly from HTML markup.
 
 In case you want to get a JSON payload as response, just pass `json=true`:
 
@@ -361,12 +363,13 @@ Available inputs:
 
 ### GitHub
 
-Get any GitHub user or organization's profile picture by their username.
+Get any GitHub user or organization's profile picture by username, or resolve an avatar from a public email via GitHub search when the address matches a profile or commit history.
 
 Available inputs:
 
 - User, e.g., [unavatar.io/github/mdo](https://unavatar.io/github/mdo)
 - Organization, e.g., [unavatar.io/github/vercel](https://unavatar.io/github/vercel)
+- Email address, e.g., [unavatar.io/github/sindresorhus@gmail.com](https://unavatar.io/github/sindresorhus@gmail.com)
 
 ### GitLab
 
@@ -495,7 +498,7 @@ Get any PlayStation Network user's profile picture by their PSN username.
 
 Available inputs:
 
-- Username, e.g., [unavatar.io/psnprofiles/P3](https://unavatar.io/psnprofiles/P3)
+- Username, e.g., [unavatar.io/psnprofiles/Duff85](https://unavatar.io/psnprofiles/Duff85)
 
 ### Reddit
 
@@ -644,7 +647,7 @@ Get any Xbox player's profile picture by their gamertag.
 
 Available inputs:
 
-- Gamertag, e.g., [unavatar.io/xboxgamertag/P3](https://unavatar.io/xboxgamertag/P3)
+- Gamertag, e.g., [unavatar.io/xboxgamertag/GD-BerserkerTTD](https://unavatar.io/xboxgamertag/GD-BerserkerTTD)
 
 ### YouTube
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@unavatar/core",
   "description": "Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube & more.",
   "homepage": "https://unavatar.io",
-  "version": "3.19.5",
+  "version": "3.19.7",
   "main": "src/index.js",
   "exports": {
     ".": "./src/index.js",