meshtastic-protobuf/README.md

# Meshtastic Protobuf Definitions

[![CI](https://img.shields.io/github/workflow/status/meshtastic/protobufs/CI?label=actions&logo=github&color=yellow)](https://github.com/meshtastic/protobufs/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/protobufs)](https://cla-assistant.io/meshtastic/protobufs)
[![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

The [Protobuf](https://developers.google.com/protocol-buffers) message definitions for the Meshtastic project (used by apps and the device firmware).

**[Documentation/API Reference](https://meshtastic.org/docs/developers/protobufs/api)**

## Stats

![Alt](https://repobeats.axiom.co/api/embed/47e9ee1d81d9c0fdd2b4b5b4c673adb1756f6db5.svg "Repobeats analytics image")

## Linter Setup

Linting is performed by [protolint](https://github.com/yoheimuta/protolint)
Once installed, the Visual Studio Code extension [Proto Lint](https://marketplace.visualstudio.com/items?itemName=Plex.vscode-protolint) will perform linting automatically on save.