Blog

Vaadin Directory now welcomes custom GitHub badges

By  
Binh Bui
Binh Bui
·
On Apr 3, 2018 6:00:00 AM
·
In

Good news for all component authors! Vaadin Directory now supports custom badges which you can use in your GitHub repository. It’s cool, it’s concise and most of all, it shows meaningful information to your users about your component.

Like most GitHub badges, you showcase them by writing some lines in your vaadin-directory-description.md or README.md file. Here is how to show the rating for our most popular web component, vaadin-button:

  1. Copy [![Vaadin Directory star rating for vaadin-button](http://img.shields.io/vaadin-directory/star/vaadinvaadin-button.svg)](https://vaadin.com/directory/component/vaadinvaadin-button)
  2. Paste it in vaadin-directory-description.md or README.md
  3. Save and done!

By giving the keyword rating, you are telling the server the information you want. At the current time, we support these keys: star, status, rating, rating-count or rc, version or v, release-date or rd.

For obtaining the status badge, we recommend using the static badge since it's much faster

[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/<YourElementURLIdentifier>)

You may have noticed that vaadinvaadin-button is the URL identifier for vaadin-button, and you should change this according to your own.

Showcasing your component's rating on your GitHub page will directly communicate the quality you strive for, to your potential users. In the meantime, check out this component to see them in action.

Check out Vaadin Directory

Relevant articles:

Binh Bui
Binh Bui
Binh is a Growth Marketer involved with multiple domains ranging from running experiments, campaigns to doing product-led growth stuff. He likes using his brain and he likes random discussions. Out of work, you can see Binh in the Schrodinger gym. Follow Binh on Twitter @buibaobin
Other posts by Binh Bui