Skip to content

Commit

Permalink
Specification: Add better alt-text (#6448)
Browse files Browse the repository at this point in the history
  • Loading branch information
ajs256 authored May 4, 2021
1 parent d02da3d commit fba0bdf
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions spec/SPECIFICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ This document specifies the visual design of Shields badges.

#### Bad

![bad example](https://img.shields.io/badge/MySuperSaaSisSoAwesome.com-1.1.1-orange.svg)
![Bad example, with the text "MySuperSaaSisSoAwesome.com" on the left side](https://img.shields.io/badge/MySuperSaaSisSoAwesome.com-1.1.1-orange.svg)

The key is shamelessly promoting the service provider instead of giving context to the value. If service providers want to promote themselves, they can simply encourage people to link back to them and let folks who are curious click on the button for more information.

#### Good

![good example](https://img.shields.io/badge/version-1.1.1-green.svg)
![Good example, with the text "version" on the left side](https://img.shields.io/badge/version-1.1.1-green.svg)

The key clearly explains what the value stands for (the version of the software provided). The platform or service hosting the version of the software is only relevant to people who decide to click on an eventual link added to the badge itself but the value stands on its own with the metadata value it provides to viewers.

Expand Down

0 comments on commit fba0bdf

Please sign in to comment.