From 9e1fc0b7da0e8f3721958c6db4d7b59ff841e5a3 Mon Sep 17 00:00:00 2001 From: Ayushi Vishwakarma Date: Mon, 3 Oct 2022 12:44:37 +0530 Subject: [PATCH] update default values in readme (#2094) * update default values in readme * docs: improve formatting * docs: improve readme punctation Co-authored-by: rickstaa --- readme.md | 8 ++++---- src/cards/repo-card.js | 2 +- src/cards/top-languages-card.js | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/readme.md b/readme.md index b18cdf6..2f18336 100644 --- a/readme.md +++ b/readme.md @@ -203,12 +203,12 @@ You can provide multiple comma-separated values in the bg_color option to render #### Repo Card Exclusive Options: -- `show_owner` - Show the repo's owner name _(boolean)_ +- `show_owner` - Show the repo's owner name _(boolean)_. Defaults to `false`. #### Language Card Exclusive Options: - `hide` - Hide the languages specified from the card _(Comma-separated values)_ -- `hide_title` - _(boolean)_ +- `hide_title` - _(boolean)_. Defaults to `false`. - `layout` - Switch between two available layouts `default` & `compact` - `card_width` - Set the card's width manually _(number)_ - `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_ @@ -223,8 +223,8 @@ You can provide multiple comma-separated values in the bg_color option to render #### Wakatime Card Exclusive Options: - `hide` - Hide the languages specified from the card _(Comma-separated values)_ -- `hide_title` - _(boolean)_ -- `line_height` - Sets the line-height between text _(number)_ +- `hide_title` - _(boolean)_. Defaults to `false`. +- `line_height` - Sets the line-height between text _(number)_. Default Value: `25`. - `hide_progress` - Hides the progress bar and percentage _(boolean)_ - `custom_title` - Sets a custom title for the card - `layout` - Switch between two available layouts `default` & `compact` diff --git a/src/cards/repo-card.js b/src/cards/repo-card.js index 7c9c4b5..5730ea4 100644 --- a/src/cards/repo-card.js +++ b/src/cards/repo-card.js @@ -88,7 +88,7 @@ const renderRepoCard = (repo, options = {}) => { icon_color, text_color, bg_color, - show_owner, + show_owner = false, theme = "default_repocard", border_radius, border_color, diff --git a/src/cards/top-languages-card.js b/src/cards/top-languages-card.js index b181fc1..b837b35 100644 --- a/src/cards/top-languages-card.js +++ b/src/cards/top-languages-card.js @@ -235,7 +235,7 @@ const useLanguages = (topLangs, hide, langs_count) => { */ const renderTopLanguages = (topLangs, options = {}) => { const { - hide_title, + hide_title = false, hide_border, card_width, title_color,