From 2173ad7c714724fc0282ca099582f9d0d159fac0 Mon Sep 17 00:00:00 2001 From: Jon Barlow Date: Wed, 17 Aug 2016 13:51:22 +0100 Subject: [PATCH] Add some note about Rocky.js (#134) --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 4fb11a0..4b91463 100755 --- a/README.md +++ b/README.md @@ -45,6 +45,9 @@ If you would like to contribute to Clay, check out the [contributing guide.](CON # Getting Started (Pebble.js) If you are using [Pebble.js](https://developer.pebble.com/docs/pebblejs/) and would like to use Clay, The setup process is a little different. Pebble.js does not currently support message keys so you will have to use [v0.1.7](https://github.com/pebble/clay/releases/v0.1.7) of Clay. Follow the instructions in the [readme for that version.](https://github.com/pebble/clay/blob/v0.1.7/README.md) +# Getting Started (Rocky.js) +If you are using [Rocky.js](https://developer.pebble.com/docs/rockyjs/) and would like to use Clay, please be aware that this is currently unsupported. It is possible to install the Clay package and override the 'showConfiguration' and 'webviewclosed' events and handle them manually, but Rocky.js does not currently support persistent storage, so the settings must be loaded from the phone each time. You can find an example of using Clay with Rocky.js [here](https://github.com/orviwan/rocky-leco-clay). + # Creating Your Config File Clay uses JavaScript object notation (or JSON) to generate the config page for you. The structure of the page is up to you, but you do need to follow some basic rules.