diff --git a/readme.md b/readme.md index bfe042fc..7108a8f9 100644 --- a/readme.md +++ b/readme.md @@ -92,6 +92,7 @@ Visit and make a small donation to hel - [Repo Card Exclusive Options](#repo-card-exclusive-options) - [Language Card Exclusive Options](#language-card-exclusive-options) - [Wakatime Card Exclusive Option](#wakatime-card-exclusive-options) +- [Wild Cards](#wild-cards) - [Deploy Yourself](#deploy-on-your-own-vercel-instance) - [Keep your fork up to date](#keep-your-fork-up-to-date) @@ -495,6 +496,64 @@ By default, GitHub does not lay out the cards side by side. To do that, you can ``` +## Wild Cards +You can also generate custom cards with custom text and custom values (these do not show any GitHub statistics - they're custom values that you provide): +

+ + + + +

+ +The wild/custom cards can be generated by using the `/api/wild/`, `/api/wild/top-langs/`, and `/api/wild/pin/` endpoints. The following parameters can be provided: + +### `/api/wild/` + + + +Additionally, the `score` parameter must be given a value from `0` to `100` where `100` doesn't fill the circle at all, and `0` fills the circle completely (the demo above has `score=90`). + +### `/api/wild/top-langs/` + + + +Here, the languages are defined using the `langs` parameter. It is of the following format (JSON with `;` separating the objects): +```json +{ + "name": "Category1", + "size": 60, + "color": "4287f5", + "text": "3 thousand" +}; +{ + "name": "Category2", + "size": 40, + "color": "fcba03", + "text": "3 thousand" +} +``` + +`name` is the name of the category. `size` is an arbitary size used to calculate percentages. This can be hours, percent, or any other unit you wish to use. `color` is the color of the category. `text` is what text to display next to the categry. If left blank, a percentage will be calculated and displayed. + +### `/api/wild/pin/` + + + +Here, the `badge` parameter was used to set the color of the small round icon (`4287f5`) was passed. + +Finally, here are some specifications that apply to all three endpoints. + +### All Three +Colors are passed as hex codes without the `#` character. For example, `ffffff`. This is the same as the main API. + +Parameters like `total_stars` and `forks` can accept both numbers and text. If a number is given, it will automatically be formatted to use k-notation for thousands. + +Parameters that apply only to the main API such as `username`, `repo`, `show_owner`, `locale, etc won't work for this API. Other parameters like `layout` and `text_color` ***will*** work. + +The new parameters that have been added are explained above (shown in the images). Parameters are lowercase snake-cased like for the main API. + +Finally, no parameter is required (yay!) :) If essential parameters like `total_stars` aren't given, random values will be used, which is not very useful, but this is so that no errors are formed! + ## Deploy on your own Vercel instance #### [Check Out Step By Step Video Tutorial By @codeSTACKr](https://youtu.be/n6d4KHSKqGk?t=107)