Skip to content

gadicc/contributors-svg

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

contributors-svg

Service to show contributor faces in your project README with SVG.

Copyright (c) 2021 by Gadi Cohen dragon@wastelands.net. MIT Licensed.

Quick Start

Just add the following to your README (replacing USER and REPO):

![contributor-faces](https://contributors-svg.vercel.app/api/svg?user=USER&repo=REPO)

It looks like this (for node-yahoo-finance2):

contributor-faces

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:

<object
  type="image/svg+xml"
  data="https://contributors-svg.vercel.app/api/svg?user=USER&repo=REPO"
/>

Thanks to Vercel 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 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

Releases

No releases published

Packages

No packages published