Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 3.21 KB

README.md

File metadata and controls

61 lines (42 loc) · 3.21 KB

Pelion Device Management SDK for JavaScript

No Maintenance Intended


Due to a redirected focus onto future development of the Pelion Device Management APIs, this SDK Is no longer actively supported and there is no commitment for future maintenance releases.

The open source project and corresponding packages for this SDK remain publicly available.

Existing applications developed using the SDK will continue to operate against existing Pelion Device Management REST APIs (assuming that those APIs are not subject to the deprecation process for commercial customers). New APIs supported by Pelion Device Management will only be available through the REST APIs.

It is recommended that for ongoing development, applications which previously used the SDK should be migrated over time to access the Pelion Device Management REST APIs directly.

Please see this page, which provides additional information on using the REST APIs. By following this guide, you will learn how to build a web application using the REST APIs directly.


License version CircleCI codecov engine downloads

The Pelion Device Management SDK provides a simplified interface to the Pelion Device Management APIs by exposing functionality using conventions and paradigms familiar to JavaScript developers.

Prerequisites

Node.js > v10.16.0 (lts) yarn

Installation

The SDK is distributed using npm. To install the package in your project:

$ yarn add mbed-cloud-sdk

/node_modules/mbed-cloud-sdk now contains:

  • bundles - minified browser scripts.
  • lib - CommonJS modules.
  • lib-es6 - ESNext modules.
  • types - Typescript types.

Documentation and examples

See the full documentation and API reference at https://cloud.mbed.com/docs/latest/mbed-cloud-sdk-javascript.

Please refer to the examples folder for some node and web examples.

Contributing

Pelion Device Management SDK for JavaScript is open source and we would like your help; there is a brief guide on how to get started in CONTRIBUTING.md.

License

Pelion Device Management SDK for JavaScript is free-to-use and licensed under the Apache License 2.0. See LICENSE file for more information.