DEV Community

Cover image for Beautify README files with badges
Médéric Burlet
Médéric Burlet

Posted on

Beautify README files with badges

Following the README hype!!!

Not to long ago I discovered an awesome tool for adding badges to your various markdown files.

https://shields.io


API based badges

Looking at the landing page we can already see a various set of categories:

shield-landing-page

From their you can navigate and choose a service that interests you for instance:

social --> twitter follow

You can then fully customize basic settings:

Alt Text

Result:

Twitter Follow

Here are a few possibilities:

GitHub commit activity

Website


Custom badges

If you scroll to the bottom of the page, shields.io let's you create custom badges

Alt Text

This lets you create everything and anything and even use data urls.

Here are a few possibilities:

Website

Email

For more badges and cool stuff check out https://shields.io


Burlet Mederic
https://mederic.me
https://twitter.com/crimson_med

Top comments (2)

Collapse
 
kvanrooyen profile image
Keagan Van Rooyen

I didn't even think of using these in posts 🙈 great article and thanks for the idea

Collapse
 
crimsonmed profile image
Médéric Burlet

You can add them at the bottom for links! it gives some vibrance!