@stats-forge/github-stats-forge-core
v0.15.0
Published
Dynamically generate stats for your GitHub readme
Maintainers
Readme
@stats-forge/github-stats-forge-core
The library behind GitHub Stats Forge: it turns GitHub and WakaTime data into SVG cards.
Nothing here reads the environment or the filesystem — you pass a config in, you get a string of SVG back — so it behaves the same under Node, in a browser and under a test runner. It is what the CLI, the action and every self-hosted instance call.
npm install @stats-forge/github-stats-forge-coreimport { CardConfig, stats } from '@stats-forge/github-stats-forge-core/api';
const config = new CardConfig({ pats: [{ name: 'PAT_1', value: process.env.PAT_1! }] });
const result = await stats({ username: 'anuraghazra', theme: 'cobalt_dark' }, config);
// `content` is an SVG either way: a failure is a card that says what went wrong.
response.setHeader('Content-Type', 'image/svg+xml');
response.end(result.content);Requires Node ^24 || >=26.
[!TIP] The library documents the handlers,
CardConfig, the error codes and the entry points. Every card has a page of its own.
Acknowledgements
It continues the work of github-stats-extended, which is itself based on github-readme-stats.
