1.0.4 ā¢ Published 2 years ago
@jckimble/github-graph-background v1.0.4
Welcome to GitHub Graph Background š
A toy program for getting your GitHub Contributions and creating a background image from it with many themes.
Install
npm install @jckimble/github-graph-backgroundUsage
github-graph-backgroundOptions
Github Token can be read from the GITHUB_TOKEN Environment Variable
| Option | Description | Default |
|---|---|---|
| --output | Image Output | ./background.png |
| --width | Image Width | 1366 |
| --height | Image Height | 768 |
| --margin | Spacing Between Blocks | 2 |
| --token | GitHub Token | N/A |
| --theme | Color Theme | green |
Themes
Small Images of themes are in releases named by the theme option. Special value of random picks a theme at random. Default theme is green. Current themes are: green, blue, red, rose, fullrandom and random along with their dark variants. Adding :dark after a theme name generates the dark version.
Run tests
npm run testAuthor
š¤ James C Kimble Jr
- Website: https://jckimble.com
- Twitter: @jckimble601
- Github: @jckimble
- LinkedIn: @james-kimble-865092212
š¤ Contributing
Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.
Show your support
Give a āļø if this project helped you!
Donations
š License
Copyright Ā© 2023 James C Kimble Jr.
This project is MIT licensed.