Commit Graph

155 Commits

Author SHA1 Message Date
Pranav Joglekar 9aa39dfe81 feat: allow users to pass ring_color param (#2075)
* fix: prevent crash if undefined color is passed to func fallbackColor

* feat: allow users to pass ring_color param

Before this commit, the ring color was always equal to the title color.
This commit allows the user to pass a ring_color property to allow him
to style the ring color the way he pleases to. If no ring_color is
passed we default to the title color.

* docs: improves ring color documentation

* fix: improve code style

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-11-19 20:18:42 +01:00
Rick Staa f993f21379 Update readme.md 2022-10-28 10:03:11 +02:00
Falguni Sarkar 45f434f083 docs: document auto theme change #2074 (#2229)
* Document auto theme change in README #2074

* Document auto theme change in README

Document auto theme change in README #2074 (update-1)

* Document auto theme change updates

#2074

* docs: improve dynamic theme documentation

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-28 09:43:17 +02:00
Frieder Bluemle 199870aa9f refactor: fix GitHub capitalization (#2232) 2022-10-26 16:41:59 +02:00
rickstaa 166972d7e4 docs: improve syntax 2022-10-10 13:49:48 +02:00
rickstaa c4bfacb9e0 docs: add fork update guide 2022-10-10 13:48:35 +02:00
rickstaa d7451d8288 docs: improve caching documentation 2022-10-07 14:53:51 +02:00
rickstaa 5c514dbda0 docs: improve admonition boxes 2022-10-07 14:43:16 +02:00
rickstaa 15533596e6 docs: add admonition boxes 2022-10-07 14:40:19 +02:00
rickstaa df243efdd5 docs: update readme 2022-10-07 14:32:01 +02:00
Rick Staa 94d0978d2b docs: fix readme logo alignment (#2112) 2022-10-04 14:19:30 +02:00
Akshat Goel 388ba06a8f Update the Vercel deployement guide (#2102)
* Update the Vercel deployement guide

Updated Readme.md - The guide on deploying your own Vercel instance

* docs: fix some small grammer errors

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-04 09:32:40 +02:00
Rick Staa e6a6384eff docs: improve readme syntax (#2106) 2022-10-04 09:19:37 +02:00
Aditya Shelke 7accd1a8d7 feat: default values for wakatime and language (#2103)
* default values for wakatime and language

* docs: update formatting

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-04 08:58:18 +02:00
Ayushi Vishwakarma 9e1fc0b7da update default values in readme (#2094)
* update default values in readme

* docs: improve formatting

* docs: improve readme punctation

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-10-03 09:14:37 +02:00
Manan1612 aa084f31c4 Added Contributors Badge (#2096) 2022-10-03 08:42:32 +02:00
rickstaa c5bea57638 docs: fix india care logo 2022-10-02 18:07:43 +02:00
rickstaa c2c984a872 docs: format readme 2022-10-02 17:58:34 +02:00
ianbromwichuos 2faf9c54ff docs: fix link to go India logo svg (#2085) 2022-10-02 17:47:14 +02:00
Jagruti Tiwari f0daab11c8 feat: added default options to readme (#2051)
* feat: added default options to readme

* Update readme.md

Co-authored-by: Rick Staa <rick.staa@outlook.com>

* fix: added default values for stats card

* style: some small readme changes

Co-authored-by: Rick Staa <rick.staa@outlook.com>
2022-10-02 14:03:22 +02:00
Rick Staa f9b9015ec2 feat(stats): add 'not_bold' option to stats card (#1468) 2022-09-17 13:32:40 +02:00
Rick Staa c1324b31bf feat: add 'exclude_repo' option to stats card (#1450)
This commit allows users to exclude repositories for the stats card
using the `exclude_repo` option.
2022-09-16 13:09:19 +02:00
Artem Kostiuk b0bb994ad3 Fix #1170: Allow customizable width for GitHub Stats Card (#1334)
* Change default stats card width with hide rank

* Add tests for stats card with card_width

* Add card_width Stats Card description to readme

* fix: add icon width to stats-card min width calculation

* fix: fixes rank circle padding problem

This commit fixes a padding problem that was introduced in
f9c0e0bff64f325235ccbf936c9d5f7a918ac790. In the new code, the padding
around the rank circle will be 50 when the stats card is bigger than
450. When it is smaller than 450 the left and right padding will shrink
equally.

* style: run prettier

* tests: add extra stats 'card_width' tests

This commit makes sure we also test the stats card width for the case that the 'show_icons'
option is enabled.

* style: run prettier

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-09-16 12:50:30 +02:00
John Sweeney d5c94b6f57 Remove unneeded underscore from Readme (#2003) 2022-09-06 08:50:39 +02:00
tmt 678fa11416 docs: note for temporary cache inc (#1890) 2022-07-27 07:48:20 +02:00
tmt cffb0843b1 docs: incorrect cache documentation (#1889) 2022-07-27 07:47:55 +02:00
PyBaker 33874275b2 docs: update readme.md (#1836) 2022-07-06 13:00:20 +02:00
Rick Staa bdaaba2021 docs: add wakatime public profile note (#1794)
Add a small note to make users aware that the wakatime card currently only works with public profiles.
2022-06-23 11:43:02 +02:00
Rick Staa 758ed96dce docs: add discussion button to readme (#1776)
This commit adds a link to the discussion page to make sure people ask questions there instead of opening issues.
2022-05-19 12:40:35 +02:00
Nico Ismaili 9734a998cc docs: linked "hide" URL param values to its description (#1766) 2022-05-18 16:36:22 +02:00
Subramani bde609f246 Update readme.md (#1399)
Co-authored-by: Rick Staa <rick.staa@outlook.com>
2022-05-03 10:26:21 +02:00
0xLogN 877ac89e84 spelling & grammar in README (#1350) 2022-05-03 10:12:49 +02:00
Robin Millette 202bcd4451 Fix readme typo (#1171)
Langauges
2022-05-03 10:04:45 +02:00
Chinmay Chhajed f7ddcbe757 docs: update readme (#1721)
This pull request fixes several syntax errors in the readme that might confuse people.
2022-05-01 21:20:51 +02:00
Ansgar Grunseid 20ace75271 fix grammar: add missing period (#1025) 2022-02-16 23:12:32 +01:00
SiddharthMehra c3d9197912 fix grammatical error in readme.md (#975)
* update readme.md

* docs: apply one small grammar style change

Co-authored-by: rickstaa <rick.staa@outlook.com>
2022-02-16 08:24:56 +01:00
James Tufarelli 3f0ca9d967 docs: fixed Vercel PAT setup instructions (#1508)
Updated the Vercel PAT setup instructions.

The original instructions don't say to enable `repo` permissions on the Personal Access Token. Without these permissions, the widget was not able to count the `total commits` on my private repos. I updated the instructions to specifically mention enabling the `repo` permission on the PAT.

I tested this using my own Vercel instance and can confirm the `repo` permission is needed.

This fix has been mentioned here: https://github.com/anuraghazra/github-readme-stats/issues/1275#issuecomment-929887319
2021-12-29 21:17:31 +05:30
Anurag Hazra bc6c22ea17 docs: add fork instructions (#1418)
* docs: add fork instructions

* chore: revert toc
2021-10-25 23:29:04 +05:30
Moe Bachrouch c7fd3ed8f2 docs: replace '?theme' with '&theme' (#1307) 2021-09-12 21:42:07 +05:30
Julian Holfeld 1a3edcaae0 feat: hide wakatime languages (#1212)
* feat: added option to hide languages

* feat: recalculate percentages for hidden languages

* refactor: reverted langs_count and did some formatting

* doc: added hide to readme

* feat: make languages var mutable and improve filter logic

Co-authored-by: Adrian Kunz <clashsoft@hotmail.com>

* refactor: improve code and added tests

Co-authored-by: Adrian Kunz <clashsoft@hotmail.com>
Co-authored-by: Anurag <hazru.anurag@gmail.com>
2021-08-28 00:35:10 +05:30
김예환 Ye-Hwan Kim (Sam) ae6b56bf7f docs: fix grammar (#1242) 2021-08-14 20:37:36 +05:30
OldWizard209 fede678fa2 docs: better navigation in readme (#1196) 2021-07-20 12:49:21 +05:30
Rishi Suresh 7a096acf66 feat: added border_color option (#1000)
* feat: Allow customization of border color

* docs: Update readme
2021-04-28 00:28:44 +05:30
Florian Bussmann 9773d924fb feat: limit langs shown on wakatime card (#988) 2021-04-27 00:34:34 +05:30
Anurag Hazra 979f9a4946 docs: add covid fund link (#1019) 2021-04-26 14:09:22 +05:30
Peter Dave Hello c8c3358f1b docs: correct code block language in readme.md (#949)
This one is html not markdown
2021-03-21 18:19:16 +05:30
Ferdinand Mütsch 24e5f866c0 feat: allow to customize wakatime range (#874)
* chore: allow to customize wakatime data range

* docs: document wakatime range parameter
docs: add wakatime section to german readme

Co-authored-by: Anurag Hazra <hazru.anurag@gmail.com>
2021-03-08 11:39:43 +05:30
Teddy Heinen c8a5e835a5 feat: add corner rounding parameter so we can make square cards (#845)
* add corner rounding parameter so i can make square cards

* rename rx to border_radius
2021-03-07 22:23:32 +05:30
Alexandr fcc51020ff docs: added missing link to nepali translations (#912) 2021-03-07 22:04:53 +05:30
Anaxes 1e36b20057 docs: update readme.md (#914)
Updated one word "Loved" to "Love".
2021-03-07 22:04:36 +05:30