Skip to content

Commit 7accd1a

Browse files
adi-uchiharickstaa
andauthored
feat: default values for wakatime and language (#2103)
* default values for wakatime and language * docs: update formatting Co-authored-by: rickstaa <[email protected]>
1 parent c03bb2f commit 7accd1a

File tree

1 file changed

+28
-30
lines changed

1 file changed

+28
-30
lines changed

readme.md

+28-30
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<p align="center">
77
<a href="https://github.com/anuraghazra/github-readme-stats/actions">
88
<img alt="Tests Passing" src="https://github.com/anuraghazra/github-readme-stats/workflows/Test/badge.svg" />
9-
</a>
9+
</a>
1010
<a href="https://github.com/anuraghazra/github-readme-stats/graphs/contributors">
1111
<img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/anuraghazra/github-readme-stats" />
1212
</a>
@@ -64,18 +64,16 @@
6464
</p>
6565
<p align="center">Love the project? Please consider <a href="https://www.paypal.me/anuraghazra">donating</a> to help it improve!
6666

67-
<p>
6867
<a href="https://indiafightscorona.giveindia.org">
69-
<img src="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png" alt="Give india logo" width="200" />
68+
<img src="https://indiaspora.org/wp-content/uploads/2021/04/give-India-logo.png" alt="Give india logo" width="200" />
7069
</a>
7170

7271
Are you considering supporting the project by donating? Please DON'T!!
7372

7473
Instead, Help India fight the 2nd deadly wave of COVID-19.
7574
Thousands of people are dying in India because of a lack of Oxygen & also COVID-related infrastructure.
7675

77-
Visit <https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis.
78-
A small donation goes a long way. :heart:
76+
Visit <https://indiafightscorona.giveindia.org> and make a small donation to help us fight COVID and overcome this crisis. A small donation goes a long way. :heart:
7977

8078
</p>
8179

@@ -142,13 +140,13 @@ To enable icons, you can pass `show_icons=true` in the query param, like so:
142140

143141
With inbuilt themes, you can customize the look of the card without doing any [manual customization](#customization).
144142

145-
Use `&theme=THEME_NAME` parameter like so :-
143+
Use `&theme=THEME_NAME` parameter like so :
146144

147145
```md
148146
![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)
149147
```
150148

151-
#### All inbuilt themes:-
149+
#### All inbuilt themes
152150

153151
dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula
154152

@@ -160,7 +158,7 @@ You can look at a preview for [all available themes](./themes/README.md) or chec
160158

161159
You can customize the appearance of your `Stats Card` or `Repo Card` however you wish with URL params.
162160

163-
#### Common Options:
161+
#### Common Options
164162

165163
- `title_color` - Card's title color _(hex color)_. Default: `2f80ed`.
166164
- `text_color` - Body text color _(hex color)_. Default: `434d58`.
@@ -183,7 +181,7 @@ You can provide multiple comma-separated values in the bg_color option to render
183181

184182
> Note on cache: Repo cards have a default cache of 4 hours (14400 seconds) if the fork count & star count is less than 1k, otherwise, it's 2 hours (7200 seconds). Also, note that the cache is clamped to a minimum of 2 hours and a maximum of 24 hours.
185183
186-
#### Stats Card Exclusive Options:
184+
#### Stats Card Exclusive Options
187185

188186
- `hide` - Hides the [specified items](#hiding-individual-stats) from stats _(Comma-separated values)_. Default: `[] (blank array)`.
189187
- `hide_title` - _(boolean)_. Default: `false`.
@@ -201,36 +199,36 @@ You can provide multiple comma-separated values in the bg_color option to render
201199
> Note on `hide_rank`:
202200
> When hide_rank=`true`, the minimum card width is 270 px + the title length and padding.
203201
204-
#### Repo Card Exclusive Options:
202+
#### Repo Card Exclusive Options
205203

206-
- `show_owner` - Show the repo's owner name _(boolean)_. Defaults to `false`.
204+
- `show_owner` - Show the repo's owner name _(boolean)_. Default: `false`.
207205

208-
#### Language Card Exclusive Options:
206+
#### Language Card Exclusive Options
209207

210-
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
211-
- `hide_title` - _(boolean)_. Defaults to `false`.
212-
- `layout` - Switch between two available layouts `default` & `compact`
213-
- `card_width` - Set the card's width manually _(number)_
214-
- `langs_count` - Show more languages on the card, between 1-10, defaults to 5 _(number)_
215-
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_
216-
- `custom_title` - Sets a custom title for the card
208+
- `hide` - Hide the languages specified from the card _(Comma-separated values)_ .Default: `[] (blank array)`.
209+
- `hide_title` - _(boolean)_. Default: `false`.
210+
- `layout` - Switch between two available layouts `default` & `compact`. Default: `default`.
211+
- `card_width` - Set the card's width manually _(number)_. Default `300`.
212+
- `langs_count` - Show more languages on the card, between 1-10 _(number)_. Default `5`.
213+
- `exclude_repo` - Exclude specified repositories _(Comma-separated values)_. Default: `[] (blank array)`.
214+
- `custom_title` - Sets a custom title for the card _(string)_. Default `Most Used Languages`.
217215

218216
> :warning: **Important:**
219217
> Language names should be uri-escaped, as specified in [Percent Encoding](https://en.wikipedia.org/wiki/Percent-encoding)
220218
> (i.e: `c++` should become `c%2B%2B`, `jupyter notebook` should become `jupyter%20notebook`, etc.) You can use
221219
> [urlencoder.org](https://www.urlencoder.org/) to help you do this automatically.
222220
223-
#### Wakatime Card Exclusive Options:
221+
#### Wakatime Card Exclusive Options
224222

225-
- `hide` - Hide the languages specified from the card _(Comma-separated values)_
226-
- `hide_title` - _(boolean)_. Defaults to `false`.
227-
- `line_height` - Sets the line-height between text _(number)_. Default Value: `25`.
228-
- `hide_progress` - Hides the progress bar and percentage _(boolean)_
229-
- `custom_title` - Sets a custom title for the card
230-
- `layout` - Switch between two available layouts `default` & `compact`
231-
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages
232-
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi)
233-
- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options.
223+
- `hide` - Hide the languages specified from the card _(Comma-separated values)_. Default: `[] (blank array)`.
224+
- `hide_title` - _(boolean)_. Default `false`.
225+
- `line_height` - Sets the line-height between text _(number)_. Default `25`.
226+
- `hide_progress` - Hides the progress bar and percentage _(boolean)_. Default `false`.
227+
- `custom_title` - Sets a custom title for the card _(string)_. Default `Wakatime Stats`.
228+
- `layout` - Switch between two available layouts `default` & `compact`. Default `default`.
229+
- `langs_count` - Limit the number of languages on the card, defaults to all reported languages _(number)_. Default `50`.
230+
- `api_domain` - Set a custom API domain for the card, e.g. to use services like [Hakatime](https://github.com/mujx/hakatime) or [Wakapi](https://github.com/muety/wakapi) _(string)_. Default `Wakapi`.
231+
- `range` – Request a range different from your WakaTime default, e.g. `last_7_days`. See [WakaTime API docs](https://wakatime.com/developers#stats) for a list of available options. _(YYYY-MM, last_7_days, last_30_days, last_6_months, last_year, or all_time)_. Default `all_time`.
234232

235233
* * *
236234

@@ -441,7 +439,7 @@ NOTE: Since [#58](https://github.com/anuraghazra/github-readme-stats/pull/58) we
441439
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
442440
this takes time. You can use this service for free.
443441

444-
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:-
442+
However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:
445443

446444
- Giving proper credit when you use github-readme-stats on your readme, linking back to it :D
447445
- Starring and sharing the project :rocket:

0 commit comments

Comments
 (0)