Skip to content

Commit

Permalink
docs(readme): Added description of format and disabled_animations opt…
Browse files Browse the repository at this point in the history
…ions (#50)
  • Loading branch information
FajarKim authored Oct 27, 2023
1 parent 7aba812 commit 190d543
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ You can customize the appearance of all your cards however you wish with URL par
- `locale` - Sets the language in the card, you can check full list of available locales [here](#available-locales). Default: `en`.
- `border_width` - Sets the border's width manually (_number_). Default: `1`.
- `border_radius` - Corner rounding on the card. Default: `4.5`.
- `format` - Output format card option (`svg`, `png`, and `json`). Default: `svg`.
- `disabled_animations` - Disables all animations in the card (_boolean_). Default: `false`.

#### Use the transparent theme
We have included a `transparent` theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the `&theme=transparent` parameter like so:
Expand Down

0 comments on commit 190d543

Please sign in to comment.