---
id: readmes
title: README Structure
sidebar_label: READMEs
---

## Outline

All Meshtastic developers should follow this convention when writing a README for a repository.

Repobeats images can be generated at [repobeats.axiom.co](https://repobeats.axiom.co/)


```markdown
# Repo name

<!--Project specific badges here-->
[![CI](https://img.shields.io/github/workflow/status/meshtastic/repo/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/repo/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/repo)](https://cla-assistant.io/meshtastic/repo)
[![Fiscal Contributors](https://opencollective.com/meshtastic/tiers/badge.svg?label=Fiscal%20Contributors&color=deeppink)](https://opencollective.com/meshtastic/)
[![Vercel](https://img.shields.io/static/v1?label=Powered%20by&message=Vercel&style=flat&logo=vercel&color=000000)](https://vercel.com?utm_source=meshtastic&utm_campaign=oss)

## Overview

A description about the project

**[Getting Started Guide](https://example.com)**

**[Documentation/API Reference](https://example.com)**


## Stats

<!--Repobeats image here-->

<!--If the repository is a library, include this section-->
## Installation & Usage

<!--You may optionally include brief install/update instructions here-->

<!--Any other pertenant sections-->
### Compatibility
```

