Badges
Last updated
Last updated
Right below the logo viewers should find a centered row of badges covering the most important properties of your project. Badges not only provide additional eye-candy while giving your project a more professional look, they also serve as an overview of your entire README assuming that your selection of badges is meaningful. The recommended website to create and on-demand host badges is shields.io which is a well-known service. Dynamic badges should be used wherever possible, for example for the version of the most recent build. List of recommended styling options:
The style should be for-the-badge to align with modern, banner-like, look.
The text color should be white.
The label should be a fitting content descriptor, for example Language if your content is C++.
Wherever possible the logo should be set to a fitting icon from Simple Icons by providing its name. If no fitting icon is available consider using the github icon as a placeholder.
The color should be set to the logo-matching color provided by Simple Icons if available, if not you should attempt to obtain a fitting color from one of the following source (in order):
A constant color provided by GitHub. (For example the language color)
A constant color provided by the owner of whatever you're covering. (For example a logo)
The well-known green (#3fb911) or blue (#0173b3) color from the standard badges.
Please refrain from opening new issues on the Simple Icons GitHub repository regarding missing icons for popular brands and products. If the product is well-known but missing it's safe to assume that they received a take-down request for said icon in the past. A popular example being the Java programming language.
Recommended badge order:
The support platform(s).
The language(s) used.
Tool related badges.
The project's open-source license.
