From 2c2f003e15efbe4ab8586de3c8d1718e5a297b0d Mon Sep 17 00:00:00 2001 From: clach04 Date: Tue, 8 Mar 2016 18:02:49 -0800 Subject: [PATCH] Clarify config.json versus config.js differences Make example config clear, main impact is for CloudPebble usage where json is not yet an option. --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6814b45..8a62a41 100755 --- a/README.md +++ b/README.md @@ -24,7 +24,8 @@ Clay will eventually be built into the Pebble SDK. However, while it is still in # Getting Started (CloudPebble) -Clay will eventually be built into CloudPebble. However while it is still in beta, you will need to follow some steps +Clay will eventually be built into CloudPebble. However while it is still in beta, you will need to follow some steps. +NOTE these are similar to using the SDK but instead of a data file called config.json, a javascript file config.js is required. 1. Create a new JavaScript file called `clay.js`. 2. Copy the contents from the **clay.js** distribution file found in the [latest release](https://github.com/pebble/clay/releases/latest) into your newly created `clay.js` file. @@ -52,6 +53,8 @@ Your root element **must** be an array. This represents the entire page. Inside #### Example +NOTE for config.js (rather than config.json) a leading `module.exports =` is required. + ```javascript [ {