diff --git a/README.md b/README.md index 27b8f97..e64b421 100755 --- a/README.md +++ b/README.md @@ -864,6 +864,8 @@ function cssColor(color) { cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000); ``` +## Clay API (app.js) + ### `Clay([Array] config, [function] customFn, [object] options)` #### Constructor Parameters @@ -887,6 +889,7 @@ cssColor(Settings.option('BACKGROUND_COLOR') || 0xff0000); | `.meta.accountToken` | String | A unique account token that is associated with the Pebble account of the current user. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getAccountToken). | | `.meta.watchToken` | String | A unique token that can be used to identify a Pebble device. Read more [here](https://developer.pebble.com/docs/js/Pebble/#getWatchToken). | | `.meta.userData` | Any | A deep copy of the arbitrary data provided in the `options.userData`. Defaults to an empty object | +| `.version` | String | The version of Clay currently being used. | #### Methods @@ -962,7 +965,7 @@ module.exports = function(minified) { }; ``` -## Clay API +## Clay API (Custom Function) ### `ClayConfig([Object] settings, [Array] config, [$Minified] $rootContainer)` diff --git a/index.js b/index.js index 874103a..08006f7 100755 --- a/index.js +++ b/index.js @@ -4,6 +4,7 @@ var configPageHtml = require('./tmp/config-page.html'); var toSource = require('tosource'); var standardComponents = require('./src/scripts/components'); var deepcopy = require('deepcopy/build/deepcopy.min'); +var version = require('./package.json').version; /** * @param {Array} config - the Clay config @@ -38,6 +39,7 @@ function Clay(config, customFn, options) { watchToken: '', userData: {} }; + self.version = version; /** * Populate the meta with data from the Pebble object. Make sure to run this inside diff --git a/test/spec/index.js b/test/spec/index.js index 38cf8a0..ec56aba 100644 --- a/test/spec/index.js +++ b/test/spec/index.js @@ -121,6 +121,14 @@ describe('Clay', function() { }); }); + describe('.version', function() { + it('has the correct version', function() { + var config = fixture.config(['input', 'text', 'color']); + var clay = fixture.clay(config); + assert.strictEqual(clay.version, require('../../package.json').version); + }); + }); + describe('.config', function() { it('is a copy not a reference', function() { var config = fixture.config(['input', 'text', 'color']);