DEV Community

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

Posted on

12 3

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

Speedy emails, satisfied customers

Postmark Image

Are delayed transactional emails costing you user satisfaction? Postmark delivers your emails almost instantly, keeping your customers happy and connected.

Sign up

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!

Billboard image

The Next Generation Developer Platform

Coherence is the first Platform-as-a-Service you can control. Unlike "black-box" platforms that are opinionated about the infra you can deploy, Coherence is powered by CNC, the open-source IaC framework, which offers limitless customization.

Learn more

👋 Kindness is contagious

Please leave a ❤️ or a friendly comment on this post if you found it helpful!

Okay