Skip to content

mudlabs/shieldsio

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

Shieldsio

A repository of Shields.io endpoints.

Table of Contents

How to Use

  • Each badge is generated from a json file.
  • Shields.io lets you display badges by passing a json endpoint.
  • The url for all badges in this repo look like https://raw.githubusercontent.com/mudlabs/shieldsio/endpoint/badges/{{badge}}.json, where {{badge}} is the badge filename.
  • So you would create the shields.io badge with https://img.shields.io/endpoint?url={{raw-badge-url}}.

Contribute

For a full list of available properties see the Shields.io Endpoint Docs

  • To contribute a badge create a badge json file in the badges directory.
  • The style property must be set to for-the-badge.
  • No need to update this README, the automated workflow will do that for you.

    If your changes to a badge don't render immediately it's ok, github caches raw content for 5 minutes; nothing we can do about it 😒

Badges

github-action
github-action
github-action.json

github-sponsor
github-sponsor
github-sponsor.json

npm-version
npm-version
npm-version.json

paypal-me
paypal-me
paypal-me.json

python
python
python.json

Releases

No releases published

Packages

No packages published