@titenq/github-stats
v1.0.0
Published
CLI to generate a GitHub stats SVG tag and insert it into README.md
Readme
github-stats
CLI to generate a GitHub stats SVG tag and insert it into the current README.md.
Usage
npx @titenq/github-statsThe CLI asks for:
- GitHub username
- Theme (
darkorlight) - Size preset (
sm,md,lg)
Parameters
npx @titenq/github-stats --username=titenq --theme=dark --size=md
npx @titenq/github-stats -u titenq -t dark -s mdAPI Target
npm run dev uses http://127.0.0.1:3333/svg.
Other executions use https://titenq.com.br/svg.
Size Presets
sm: width380md: width560lg: width800
The width follows the selected preset, and the height is generated dynamically based on the number of languages returned for the user.
Output
The generated widget tag is inserted at the end of README.md.
After generation, the CLI prints the updated README.md path in the terminal.
If the local SVG API cannot be reached or returns a non-success status, the CLI aborts and does not write the tag to README.md.
License
Distributed under GPL-3.0. See LICENSE.txt.
⭐ Stargazers
This repository has no stargazers yet. Be the first!
