From 0a4d24c97f07b909976b206b0f3b17377fde18d7 Mon Sep 17 00:00:00 2001 From: Rangga Fajar Oktariansyah <86386385+FajarKim@users.noreply.github.com> Date: Thu, 24 Oct 2024 19:46:53 +0700 Subject: [PATCH] docs: add description for new option `photo_quality` and `photo_resize` --- README.md | 80 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 46 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 19d2d31..e648cc7 100644 --- a/README.md +++ b/README.md @@ -83,104 +83,116 @@ You can customize the appearance of all your cards however you wish with URL par

title_color

Card's title color.

-

string (hex color)

-

2f80ed

+

string
(hex color)

+

2f80ed

text_color

Body text color.

-

string (hex color)

-

434d58

+

string
(hex color)

+

434d58

icon_color

Icons color.

-

string (hex color)

-

4c71f2

+

string
(hex color)

+

4c71f2

border_color

Card's border color. Does not apply when hide_border is enabled.

-

string (hex color)

-

e4e2e2

+

string
(hex color)

+

e4e2e2

bg_color

Card's background color.

-

string (hex color or a gradient in the form of angle,start,end)

-

fffefe

+

string
(hex color or a gradient in the form of angle,start,end)

+

fffefe

stroke_color

Profile image border color. Does not apply when hide_stroke is enabled.

-

string (hex color)

-

e4e2e2 or border_color query

+

string
(hex color)

+

e4e2e2 or border_color query

username_color

Username text color.

-

string (hex color)

-

434d58 or text_color query

+

string
(hex color)

+

434d58 or text_color query

theme

Name of the theme, choose from all available themes.

-

enum

-

default

+

enum

+

default

locale

Sets the language in the card, you can check full list of available locales here.

-

enum

-

en

+

enum

+

en

border_width

Sets the border's width manually.

-

number

-

1

+

number

+

1

border_radius

Corner rounding on the card.

-

number -

4.5

+

number +

4.5

hide

Hides the specified items from stats.

-

string (comma-separated values) -

null

+

string
(comma-separated values) +

null

show

Shows additional items on stats card.

-

string (comma-separated values) -

null

+

string
(comma-separated values) +

null

format

Output format card option (i.e. svg, png, or json).

-

enum -

svg

+

enum +

svg

disabled_animations

Disables all animations in the card.

-

boolean -

false

+

boolean +

false

hide_border

Hides the card's border.

-

boolean -

false

+

boolean +

false

hide_stroke

Hides the image's profile stroke in the card.

-

boolean -

false

+

boolean +

false

+ + +

photo_quality

+

Quality of the profile image, represented as a percentage (1-100).

+

number
(percentage)

+

15

+ + +

photo_resize

+

Resize the profile image to a specific width, in pixels. Minimum allowed value is 10px.

+

number
(pixels)

+

150