Files
meshtastic-web/packages/core/README.md
T
Dan DitomasoandGitHub 7f177f6b83 Add npm publishing of JS libs (#702)
* feat: publish js libs to npm

* changed license type

* updated readme

* added id

* added exclusion for web and deno packages

* update comment

* updating env var
2025-07-10 12:28:23 -04:00

28 lines
1.3 KiB
Markdown

# @meshtastic/core
[![JSR](https://jsr.io/badges/@meshtastic/core)](https://jsr.io/@meshtastic/core)
[![CI](https://img.shields.io/github/actions/workflow/status/meshtastic/js/ci.yml?branch=master&label=actions&logo=github&color=yellow)](https://github.com/meshtastic/js/actions/workflows/ci.yml)
[![CLA assistant](https://cla-assistant.io/readme/badge/meshtastic/meshtastic.js)](https://cla-assistant.io/meshtastic/meshtastic.js)
[![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
`@meshtastic/core` Provides core functionality for interfacing with Meshtastic
devices. Installation instructions are available at
[JSR](https://jsr.io/@meshtastic/core)
[NPM](https://www.npmjs.com/org/meshtastic)
## Usage
```ts
import { MeshDevice } from "@meshtastic/core";
// Transport if provided by one of the available transport adapters
const device = new MeshDevice(transport);
```
## Stats
![Alt](https://repobeats.axiom.co/api/embed/5330641586e92a2ec84676fedb98f6d4a7b25d69.svg "Repobeats analytics image")