https://github.com/gadicc/contributors-svg
Code for Contributors SVG service
https://github.com/gadicc/contributors-svg
Last synced: 10 months ago
JSON representation
Code for Contributors SVG service
- Host: GitHub
- URL: https://github.com/gadicc/contributors-svg
- Owner: gadicc
- License: mit
- Created: 2021-02-12T08:18:16.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2021-09-04T15:35:53.000Z (almost 5 years ago)
- Last Synced: 2025-04-05T10:30:10.904Z (about 1 year ago)
- Language: JavaScript
- Homepage: contributors-svg.gadicc.vercel.app
- Size: 23.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# contributors-svg
Service to show contributor faces in your project README with SVG.
Copyright (c) 2021 by Gadi Cohen . MIT Licensed.
## Quick Start
Just add the following to your README (replacing USER and REPO):
```md
```
It looks like this (for `node-yahoo-finance2`):
Unfortunately this embeds with SVG with an IMG tag, which breaks the individual
links and tooltips. If possible (i.e. not in GitHub), it's preferable to embed
with an OBJECT tag:
```html
```
Thanks to [Vercel](http://vercel.com/) for the free hosting. Let's hope this
doesn't get popular enough to exceed my free limits :)
## Features
- SVG with individual links and titles for each circle-clipped face
- Images are Data URL encoded so work fine with GitHub's CORS policy.
This is totally inspired by the
[Open Collective contributors.svg](https://remarkablemark.org/blog/2019/10/17/github-contributors-readme)
but for non-collective projects. I didn't like other solutions that involved
creating the markup by hand or even by script / CI.
## TODO
- [ ] Do an Etag based on data used from Github contributor graph
- [ ] Max width, multi-row.
## Contributing
Run `vercel dev` for local development.
## See also
- https://contrib.rocks/ (contributor-img; static img with single a-href around it)
- https://remarkablemark.org/blog/2019/10/17/github-contributors-readme/
- https://github.com/ngryman/contributor-faces
- https://allcontributors.org/