Skip to content

Latest commit

 

History

History
72 lines (51 loc) · 9.99 KB

File metadata and controls

72 lines (51 loc) · 9.99 KB

Badge

If you build with Fallout, link back with the badge. It is the quickest way to help other people find the project.

built with Fallout

Copy this

Markdown:

[![built with Fallout](https://img.shields.io/badge/built%20with-Fallout-F5C800?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI%2BPGNpcmNsZSBjeD0iMTIiIGN5PSIxMiIgcj0iMTIiIGZpbGw9IiNGNUM4MDAiLz48ZyBmaWxsPSIjMTExIj48Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSIzLjEiLz48cGF0aCBkPSJNOS45OSA5LjAyQTMuNiAzLjYgMCAwIDEgMTQuMDEgOS4wMkwxOC40OSAyLjM4QTExLjYgMTEuNiAwIDAgMCA1LjUxIDIuMzhaTTE1LjU5IDExLjc1QTMuNiAzLjYgMCAwIDEgMTMuNTggMTUuMjRMMTcuMDkgMjIuNDNBMTEuNiAxMS42IDAgMCAwIDIzLjU3IDExLjE5Wk0xMC40MiAxNS4yNEEzLjYgMy42IDAgMCAxIDguNDEgMTEuNzVMMC40MyAxMS4xOUExMS42IDExLjYgMCAwIDAgNi45MSAyMi40M1oiLz48L2c%2BPC9zdmc%2B)](https://github.com/Fallout-build/Fallout)

HTML:

<a href="https://github.com/Fallout-build/Fallout"><img src="https://img.shields.io/badge/built%20with-Fallout-F5C800?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI%2BPGNpcmNsZSBjeD0iMTIiIGN5PSIxMiIgcj0iMTIiIGZpbGw9IiNGNUM4MDAiLz48ZyBmaWxsPSIjMTExIj48Y2lyY2xlIGN4PSIxMiIgY3k9IjEyIiByPSIzLjEiLz48cGF0aCBkPSJNOS45OSA5LjAyQTMuNiAzLjYgMCAwIDEgMTQuMDEgOS4wMkwxOC40OSAyLjM4QTExLjYgMTEuNiAwIDAgMCA1LjUxIDIuMzhaTTE1LjU5IDExLjc1QTMuNiAzLjYgMCAwIDEgMTMuNTggMTUuMjRMMTcuMDkgMjIuNDNBMTEuNiAxMS42IDAgMCAwIDIzLjU3IDExLjE5Wk0xMC40MiAxNS4yNEEzLjYgMy42IDAgMCAxIDguNDEgMTEuNzVMMC40MyAxMS4xOUExMS42IDExLjYgMCAwIDAgNi45MSAyMi40M1oiLz48L2c%2BPC9zdmc%2B" alt="built with Fallout"></a>

Nothing needs to be hosted or downloaded. The radiation trefoil travels inside the URL as a base64 data URI, so the badge works in any README, on any host, with no image asset of your own.

Variants

All of these are the same badge with different shields.io parameters.

Variant Markdown
built with Fallout Default see Copy this above
built with Fallout flat-square append &style=flat-square
built with Fallout for-the-badge append &style=for-the-badge
built with Fallout Dark label append &labelColor=111111
powered by Fallout "powered by" replace built%20with with powered%20by
Fallout Name only drop the built%20with- part of the path
built with Fallout Monochrome trefoil use the white logo below — fits a badge row that is otherwise all monochrome

The monochrome variant in full:

[![built with Fallout](https://img.shields.io/badge/built%20with-Fallout-F5C800?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCI%2BPGcgZmlsbD0iI2ZmZiI%2BPGNpcmNsZSBjeD0iMTIiIGN5PSIxMiIgcj0iMy4xIi8%2BPHBhdGggZD0iTTkuOTkgOS4wMkEzLjYgMy42IDAgMCAxIDE0LjAxIDkuMDJMMTguNDkgMi4zOEExMS42IDExLjYgMCAwIDAgNS41MSAyLjM4Wk0xNS41OSAxMS43NUEzLjYgMy42IDAgMCAxIDEzLjU4IDE1LjI0TDE3LjA5IDIyLjQzQTExLjYgMTEuNiAwIDAgMCAyMy41NyAxMS4xOVpNMTAuNDIgMTUuMjRBMy42IDMuNiAwIDAgMSA4LjQxIDExLjc1TDAuNDMgMTEuMTlBMTEuNiAxMS42IDAgMCAwIDYuOTEgMjIuNDNaIi8%2BPC9nPjwvc3ZnPg%3D%3D)](https://github.com/Fallout-build/Fallout)

Logo source

The trefoil is a compact SVG on a 24x24 grid, about 400 bytes. It is a yellow disc, a black hub, and one path holding the three blades:

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><circle cx="12" cy="12" r="12" fill="#F5C800"/><g fill="#111"><circle cx="12" cy="12" r="3.1"/><path d="M9.99 9.02A3.6 3.6 0 0 1 14.01 9.02L18.49 2.38A11.6 11.6 0 0 0 5.51 2.38ZM15.59 11.75A3.6 3.6 0 0 1 13.58 15.24L17.09 22.43A11.6 11.6 0 0 0 23.57 11.19ZM10.42 15.24A3.6 3.6 0 0 1 8.41 11.75L0.43 11.19A11.6 11.6 0 0 0 6.91 22.43Z"/></g></svg>

To rebuild a badge URL by hand: base64-encode that SVG, prefix it with data:image/svg+xml;base64,, URL-escape the result, and pass it as logo=.

Two things to know if you modify it:

  • logoColor does not apply. shields.io only recolours its own named icons, not custom data URIs. A custom logo keeps the fill colours written into its SVG. That is why the yellow and the white trefoil are two separate SVGs rather than one badge with a colour parameter.
  • Keep it small. The encoded logo is roughly 490 characters, which puts the whole badge URL near 640. That is comfortably inside what GitHub's image proxy accepts, but a much larger SVG is not.

Why a data URI

shields.io can render a named icon with a short ?logo=<name> parameter, but only for icons in simple-icons. Fallout is not in that set yet, because simple-icons only accepts brands above a popularity bar. Submitting the trefoil is tracked in #578. Until it lands, the data URI is the only way to get the logo into the badge, and it will stay documented here as the fallback afterwards.