Skip to content

GitHub Repo Image API for use in personal GitHub profile READMEs

License

Notifications You must be signed in to change notification settings

ryan-willis/gria

Repository files navigation

gria - github repository image api

API for fetching public repo summary images for use in GitHub profile READMEs.

Usage

To fetch an image for a public GitHub repository, in your README.md, use this markdown:

![{username}/{repository}](https://gria.smug.af/repo/{username}/{repository})

Here's what that looks like for this repository: ryan-willis/vlang

Some examples of other repositories:

This project's dependencies:

Development

This project depends on node-canvas. If you run into issues with an npm install, follow the instructions in their repository: https://github.com/Automattic/node-canvas

To run the server locally:

npm start

And visit http://localhost:6069/repo/ryan-willis/gria to see the image for this repository.