@opalkelly/frontpanel-alloy-core/README.md

Core Library for OpalKelly FrontPanel Alloy

FrontPanel Alloy Core Library
==============================

This Library provides definitions for the FrontPanel Alloy JavaScript API as well as some utilities to assist in the development of FrontPanel Alloy applications.

Getting Started tutorials, How-To guides, Technical References, and Discussion documentation pieces are available at: [FrontPanel Alloy documentation](https://docs.opalkelly.com/fpsdk/frontpanel-alloy-introduction/)

Prerequisites
-------

* FrontPanel application version 6.0.0 or greater

Applications using this library are required to run in the FrontPanel Alloy runtime environment provided by the Opal Kelly FrontPanel application.

Installation
-------

This is a [Node.js](https://nodejs.org/en/) module available through the
[npm registry](https://www.npmjs.com/).

Installation is done using the
[`npm install` command](https://docs.npmjs.com/getting-started/installing-npm-packages-locally):

```bash
$ npm install @opalkelly/frontpanel-alloy-core
```