@unavatar/core 3.25.6 → 3.25.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -8
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
- [Introduction](#introduction)
|
|
6
6
|
- [Quick start](#quick-start)
|
|
7
|
+
- [Attribution](#attribution)
|
|
8
|
+
- [How to add attribution](#how-to-add-attribution)
|
|
9
|
+
- [Remove attribution](#remove-attribution)
|
|
7
10
|
- [Authentication](#authentication)
|
|
8
11
|
- [Pricing](#pricing)
|
|
9
12
|
- [Cache](#cache)
|
|
@@ -73,18 +76,70 @@ It's proudly powered by [microlink.io](https://microlink.io/), the headless brow
|
|
|
73
76
|
|
|
74
77
|
## Quick start
|
|
75
78
|
|
|
76
|
-
The service is exposed in **unavatar.io** via
|
|
79
|
+
The service is exposed in **unavatar.io** via endpoints.
|
|
77
80
|
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
81
|
+
An endpoint determines how the avatar is looked up and what parameters are required.
|
|
82
|
+
|
|
83
|
+
For example, you can get an avatar for:
|
|
84
|
+
|
|
85
|
+
- an **email**: [unavatar.io/email/hello@microlink.io](https://unavatar.io/email/hello@microlink.io)
|
|
82
86
|
- an **username**: [unavatar.io/github/kikobeats](https://unavatar.io/github/kikobeats)
|
|
83
|
-
- a **domain**: [unavatar.io/
|
|
87
|
+
- a **domain**: [unavatar.io/domain/reddit.com](https://unavatar.io/domain/reddit.com)
|
|
88
|
+
|
|
89
|
+
Read [providers](https://unavatar.io/docs#providers) to know more. Each provider can accept different parameters.
|
|
90
|
+
|
|
91
|
+
## Attribution
|
|
92
|
+
|
|
93
|
+
Free plans require attribution. Upgrade to any paid plan to remove this requirement.
|
|
94
|
+
|
|
95
|
+
Attribution ensures proper domain verification and helps us keep unavatar.io free for the community.
|
|
96
|
+
|
|
97
|
+
Your attribution link:
|
|
98
|
+
|
|
99
|
+
- Must be on your production site (not staging or localhost).
|
|
100
|
+
- Must be publicly accessible and viewable in browsers.
|
|
101
|
+
- Must not use rel="nofollow", redirects, or obfuscation.
|
|
102
|
+
|
|
103
|
+
### How to add attribution
|
|
104
|
+
|
|
105
|
+
Add this link on any page or surface displaying unavatar.io avatars:
|
|
106
|
+
|
|
107
|
+
```html
|
|
108
|
+
[Avatars provided by Unavatar](https://unavatar.io)
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
**Example**
|
|
112
|
+
|
|
113
|
+
```html
|
|
114
|
+
|
|
115
|
+
<img src="https://unavatar.io/github/kikobeats" alt="Kiko" />
|
|
116
|
+
<img src="https://unavatar.io/x/josebaseba" alt="Joseba" />
|
|
117
|
+
|
|
118
|
+
<p class="attribution">
|
|
119
|
+
[Avatars provided by Unavatar](https://unavatar.io)
|
|
120
|
+
</p>
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**Valid placements**
|
|
124
|
+
|
|
125
|
+
Site footer, about page, credits page, or any page that renders avatars.
|
|
126
|
+
|
|
127
|
+
**Mobile apps and non-web products**
|
|
128
|
+
|
|
129
|
+
If avatars are displayed in a mobile app, desktop app, browser extension, email, or any non-web surface, add the attribution link on your app's marketing site, app store listing description, or credits screen.
|
|
130
|
+
|
|
131
|
+
**Requirements for attribution to be valid**
|
|
132
|
+
|
|
133
|
+
We reserve the right to revoke free-tier access for any website or product that does not comply with the attribution requirements described in this document:
|
|
134
|
+
|
|
135
|
+
- Double-check the href. It must point to [https://unavatar.io](https://unavatar.io/) directly — no redirects, no URL shorteners, no tracking wrappers.
|
|
136
|
+
- Make sure it's crawlable. The link must be present in the rendered HTML and not blocked by robots.txt, authentication, or region gating.
|
|
137
|
+
- Avoid nofollow or noindex. We need a standard, followable link.
|
|
138
|
+
- target="\_blank" is allowed.
|
|
84
139
|
|
|
85
|
-
|
|
140
|
+
### Remove attribution
|
|
86
141
|
|
|
87
|
-
|
|
142
|
+
Attribution is only required on the free plan. [Upgrade to the PRO plan](https://unavatar.io/checkout) to remove the requirement.
|
|
88
143
|
|
|
89
144
|
## Authentication
|
|
90
145
|
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@unavatar/core",
|
|
3
3
|
"description": "Get unified user avatar from social networks, including Instagram, SoundCloud, Telegram, Twitter, YouTube & more.",
|
|
4
4
|
"homepage": "https://unavatar.io",
|
|
5
|
-
"version": "3.25.
|
|
5
|
+
"version": "3.25.7",
|
|
6
6
|
"main": "src/index.js",
|
|
7
7
|
"exports": {
|
|
8
8
|
".": "./src/index.js",
|