# 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&#x20;

`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.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.meterian.io/badges/github.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
