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

Make SDK 3.13 notice a header & add error sample

Browse Source
This commit is contained in:
Cherie Williams
2016-06-09 14:21:10 -07:00
parent 8a2d560482
commit ecac278f63
1 changed files with 11 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+11 -1
View File
@@ -5,7 +5,17 @@ Clay will by default automatically handle the 'showConfiguration' and 'webviewcl
**Clay is still in early development and may be missing some features. We would love your feedback! Pease submit any ideas or features via GitHub Issues.**
> NOTE: Prior to SDK 3.13, require paths were handled in a non-standard way. When requiring modules, the name of the module was sufficient (ie. `require('clay')`). However, with the release of SDK 3.13, the require paths changed so that you now have to require the module by using its path relative to the file it's being required in. This means requiring the Clay module now is done in app.js by using `require('./clay')`.
# SDK 3.13 Changes
Prior to SDK 3.13, `require` paths were handled in a non-standard way. When requiring modules, the name of the module was sufficient (ie. `require('clay')`). However, with the release of SDK 3.13, the require paths changed so that you now have to require the module by using its path relative to the file it's being required in. This means requiring the Clay module now is done in app.js by using `require('./clay')`. An incorrect path would result in an error similar to this:
```
[14:16:03] javascript> JavaScript Error:
Error: Cannot find module 'clay'
at Object.loader.require (loader.js:66:11)
at _require.require (loader.js:54:48)
at Object.loader (src/js/app.js:1:1)
at _require (loader.js:57:10)
at Object.loader.require (loader.js:69:10)
```
# Getting Started (SDK)