From 0db0d852cb4cd4db60f6b8456acdc8c1f9c537c4 Mon Sep 17 00:00:00 2001 From: jimmytai Date: Wed, 13 Sep 2023 07:33:03 +0800 Subject: [PATCH] sdk docs --- docs/README.md | 2 ++ docs/sdk.md | 12 ++++++++++++ 2 files changed, 14 insertions(+) create mode 100644 docs/sdk.md diff --git a/docs/README.md b/docs/README.md index 25921f47..9f2a414f 100644 --- a/docs/README.md +++ b/docs/README.md @@ -26,6 +26,8 @@ This Guide is split up into multiple "subguides": - [Development](./development.md): For all developers. This covers how to build firmware from source and set up a development environment. +- [SDKs](./sdk.md): SDKs for Chameleon, useful if you want to develop your own application to control Chameleon. + - [Protocol](./protocol.md): The gory details of the communication protocol, useful if you want to develop your own client. ### Miscellaneous diff --git a/docs/sdk.md b/docs/sdk.md new file mode 100644 index 00000000..348ac6f7 --- /dev/null +++ b/docs/sdk.md @@ -0,0 +1,12 @@ +# SDKs + +SDKs for Chameleon, useful if you want to develop your own application to control Chameleon. + +## [taichunmin/chameleon-ultra.js](https://github.com/taichunmin/chameleon-ultra.js) + +[![GitHub Repo stars](https://img.shields.io/github/stars/taichunmin/chameleon-ultra.js?logo=github)](https://github.com/taichunmin/chameleon-ultra.js/stargazers) +[![GitHub issues](https://img.shields.io/github/issues/taichunmin/chameleon-ultra.js)](https://github.com/taichunmin/chameleon-ultra.js/issues) +[![npm](https://img.shields.io/npm/v/chameleon-ultra.js.svg?logo=npm)](https://www.npmjs.org/package/chameleon-ultra.js) +[![MIT License](https://img.shields.io/github/license/taichunmin/chameleon-ultra.js)](https://github.com/taichunmin/chameleon-ultra.js/blob/master/LICENSE) + +A JavaScript SDK for ChameleonUltra support Web Bluetooth API, Web Serial API and Node.js. There are also some demos for using the SDK. \ No newline at end of file