@hello.nrfcloud.com/proto/README.md

Documents the communication protocol between the hello.nrfcloud.com backend and the web application

# `hello.nrfcloud.com` Protocols [![npm version](https://img.shields.io/npm/v/@hello.nrfcloud.com/proto.svg)](https://www.npmjs.com/package/@hello.nrfcloud.com/proto)

[![GitHub Actions](https://github.com/hello-nrfcloud/proto/actions/workflows/build-and-publish.yaml/badge.svg)](https://github.com/hello-nrfcloud/proto/actions/workflows/build-and-publish.yaml)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
[![@commitlint/config-conventional](https://img.shields.io/badge/%40commitlint-config--conventional-brightgreen)](https://github.com/conventional-changelog/commitlint/tree/master/@commitlint/config-conventional)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier/)
[![ESLint: TypeScript](https://img.shields.io/badge/ESLint-TypeScript-blue.svg)](https://github.com/typescript-eslint/typescript-eslint)

Documents the communication protocol between the `hello.nrfcloud.com` backend
and the web application.

## Usage

```bash
npm i --save-exact @hello.nrfcloud.com/proto
```

## Setup

Install the dependencies:

```bash
npm ci
```

## Run tests

```bash
npm test
```