> For the complete documentation index, see [llms.txt](https://docs.meterian.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meterian.io/badges/github.md).

# Public repository

Generating a badge for your repository is very simple and will create and refresh a report of your project' vulnerabilities so you do not have to worry about outdated reports.

The first thing you have to do is [login](https://www.meterian.com/account) into your Meterian account and, once logged in, navigate to the 'Badges' tab.\
Here you will find a text field where to type or paste your github project url, for example 

`https://github.com/spring-projects/spring-boot`

A project branch can also be specified, although it is not mandatory.

Clicking on Generate some snippets will be created in the area below.

`[![security status](https://www.meterian.com/badge/gh/spring-projects/spring-boot/security)](https://www.meterian.com/report/gh/spring-projects/spring-boot)`

Copy and paste the snippets on your projects README.md file and the badges looking like this![security status](https://www.meterian.com/badge/gh/spring-projects/spring-boot/security) will appear on your github project README.

This badge is also a direct link to the Meterian project report page. The report for your project will be automatically created (if not existing) and automatically refreshed daily.