https://github.com/simplyhexagonal/gen-contributor-svg

Generate a contributor SVG from a GitHub username
https://github.com/simplyhexagonal/gen-contributor-svg

Last synced: about 1 year ago
JSON representation

Generate a contributor SVG from a GitHub username

• Host: GitHub
• URL: https://github.com/simplyhexagonal/gen-contributor-svg
• Owner: simplyhexagonal
• Created: 2024-04-12T18:56:00.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T19:01:12.000Z (about 2 years ago)
• Last Synced: 2025-05-09T15:24:36.899Z (about 1 year ago)
• Language: JavaScript
• Size: 3.91 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GitHub Contributor SVG Generator

This Node.js script generates an SVG file with a GitHub user's avatar and display name.

## Usage

This project is designed to be run using `npx`. You can run the script directly without installing it locally.

Run the script with the following command:

```

npx gen-contributor-svg --github-username= --display-name=

```

- Replace `` with the desired GitHub username.

- Optionally, add `--display-name=` to specify a custom display name.

The script will fetch the user's avatar image from GitHub, embed it in a template SVG file, and save the resulting SVG file as `.svg`.

## Dependencies

- axios

## License

This project is licensed under the Apache-2.0 License.