https://github.com/vendicated/github-sponsor-graph
A cli tool to generate a graph of your GitHub sponsors!
https://github.com/vendicated/github-sponsor-graph
graph readme readme-generator readme-stats sponsors
Last synced: 6 months ago
JSON representation
A cli tool to generate a graph of your GitHub sponsors!
- Host: GitHub
- URL: https://github.com/vendicated/github-sponsor-graph
- Owner: Vendicated
- License: agpl-3.0
- Created: 2023-11-13T00:14:31.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-27T22:51:14.000Z (over 1 year ago)
- Last Synced: 2024-05-01T16:49:35.920Z (over 1 year ago)
- Topics: graph, readme, readme-generator, readme-stats, sponsors
- Language: JavaScript
- Homepage:
- Size: 2.49 MB
- Stars: 14
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Sponsor Graph
A cli tool to generate a graph of your GitHub sponsors!
Recommended Usage: Create a cronjob (or equivalent) that runs this script once an hour, then serve the resulting file with the http server of your choice. Or you could do so with a github action ~ I currently have no interest in turning this into a public API; feel free to fork and do so
## Usage
First, you need to [generate a GitHub API token](https://github.com/settings/tokens/new) with the `read:user` scope
```sh
# Clone Repository
git clone https://github.com/Vendicated/github-sponsor-graph
cd github-sponsor-graph
# Install Dependencies
pnpm i # or use npm/yarn
# Run
GITHUB_TOKEN=YourTokenGoesHere node .
```
You can customise the graph using several options:
```
Usage: github-sponsor-graph [options]
Generate a graph of your GitHub sponsors
Options:
-V, --version output the version number
-s, --size Size of the images in the graph (default: 64)
-c, --images-per-row How many images should be in a row (default: 20)
-o, --out-file Where to write the graph to (default: "graph.png")
-d, --skip-default-avatars Skip default avatars
-p --include-private Also include private sponsors
-h, --help display help for command
```
## License
```
github-sponsor-graph, a tool to generate a graph of your GitHub sponsors
Copyright (c) 2023 Vendicated
SPDX-License-Identifier: AGPL-3.0-or-later
```