/holopin-readme-badge

Get yourself a Holopin markdown badge to show your collection of badges ツ

Primary LanguageJavaScriptMIT LicenseMIT

Holopin README Badge

Get yourself a Holopin markdown badge to show your collection of badges 🦖
Start collecting digital badges on Holopin if you haven't yet!



Holopin is a platform that allows you to create and collect digital badges that people love ━ this is for you if you love collecting badges. Here's my collection ━ holopin.io/@vinitshahdeo. Read "Introducing Holopin: the digital badge platform for developers!" by @elena_lape to learn more.

While Holopin already provides badge boards that can be easily embedded on GitHub and GitLab. You can now also add markdown badges to your READMEs. It's always recommended to embed badge board which is officially provided by Holopin ⎯ use it like your laptop stickers; but if you want to use a tiny badge, here's how!

My gratitude to the Holopin team for featuring me among the first four Holopals.

Here's how?

Replace vinitshahdeo in the markdown with your Holopin username. Start collecting digital badges on Holopin if you haven't yet!

Holopin

[![Holopin](https://holopin.onrender.com/vinitshahdeo)](https://holopin.io/@vinitshahdeo)

For using HTML, please replace vinitshahdeo with your Holopin username in the syntax below:

<a href='https://holopin.io/@vinitshahdeo'>
    <img src='https://holopin.onrender.com/vinitshahdeo'/>
</a>

Style your badge 🦖

Additionally it supports the styles. To use a different style: Replace flat-square in the markdown with any of the styles below ⤵

Note flat is the default style.

![Holopin](https://holopin.onrender.com/vinitshahdeo?style=flat-square)

Available styles

Style Badge
flat Holopin
flat-square Holopin
plastic Holopin
social Holopin
for-the-badge Holopin

Build locally

npm install
npm start

Run the above command and visit http://localhost:3000/

API Documentation

You can find the API Documentation on Postman or simply embed the collection using the below button:

Run in Postman

Contributing

Do you want to pitch in? If so, please consider developing a web app that generates the markdown badge dynamically based on the Holopin username entered by the user. There will be an option to copy the markdown text. You can take inspiration from the Topmate Badge Generator.

Quick start

git checkout feature/web-app
cd client
npm install
npm start

Note Please checkout issue #2

Under the hood

This is powered using an Express app which is hosted on Render, a cloud Application hosting provider for Developers! Huge shout-out to Shields.io service for providing badges in the SVG format.

Made with Express

Badge board

Holopin Badge Board can directly be embedded into your GitHub/GitLab READMEs. Learn more here. You can find my collection ⎯ holopin.io/@vinitshahdeo. Below is my board 🦖

@vinitshahdeo's Holopin board

Support

if (this.isAwesome()) {
  support(); // consider leaving a star
}

fork(🖥️) && contribute(🚀); // raise your PR to make it better

Glad to see you here! Did you love it? Show your support by leaving a star or sharing your thoughts on Twitter.

Twitter URL

Similar projects

Peerlist README Badge ⎯ Peerlist profile can be used as a simple resume or a complete portfolio to showcase your work. You can style your README with an awesome Peerlist markdown badge.

Topmate README Badge ⎯ Topmate is a platform to connect 1:1 with your audience & monetise your time better. Basically, one link to do it all. Even better, you can now add a markdown badge in your GitHub profile README to connect with your community!



⎯⎯⎯⍟✪⍟⎯⎯⎯
Made with ♡ by @vinitshahdeo for Holopin.io
✨Collect your digital badges on Holopin!✨