CriticalDepsMirror/clay
1
0
Fork 0
mirror of https://github.com/pebble-dev/clay.git synced 2026-09-05 00:27:19 -04:00
Code Issues Packages Projects Releases Wiki Activity

Clarify config.json versus config.js differences

Browse Source 
Make example config clear, main impact is for CloudPebble usage where json is not yet an option.
This commit is contained in:
clach04
2016-03-08 18:02:49 -08:00
parent 99dc081b69
commit 2c2f003e15
1 changed files with 4 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -1
View File
@@ -24,7 +24,8 @@ Clay will eventually be built into the Pebble SDK. However, while it is still in
# Getting Started (CloudPebble) # 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`. 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. 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 #### Example
NOTE for config.js (rather than config.json) a leading `module.exports =` is required.
```javascript ```javascript
[ [
{ {