From 398e43f1089177c4af287fd012aee47954b5cd4d Mon Sep 17 00:00:00 2001 From: Eric Bidelman Date: Wed, 23 Jan 2013 17:11:23 -0800 Subject: [PATCH] Tweaks to README. Mainly tabular view and a few style issues. --- README.md | 97 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 67 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index 5843de2b1b..d9d506a17a 100644 --- a/README.md +++ b/README.md @@ -12,54 +12,92 @@ Toolkitchen Toolkit is based on a set of future technologies, including [Shadow Although we plan to support all major evergreen (auto-updating) browsers, **currently Toolkit requires a Webkit browser** (essentially Chrome and Safari). -Note: Chromium has native support for ShadowDOM but Toolkit only supports the shim at this time. +Note: Chrome 25 has native support for Shadow DOM but Toolkit only supports the shim at this time. ## Getting Started To enable Custom Element functionality (et al), include the `platform/platform.js` file in your document. The platform code enables the `` for loading components. -After loading `platform/platform.js`, one can load components with `` and deploy them using simple HTML. E.g.: +After loading `platform/platform.js`, one can load components with `` and deploy them using simple HTML: - - - - - - - - - - + + + + + + + + + + -A basic example as above is available in `getting_started/index.html`. Also, there are various samples in the `workbench` folder that are intended to exercise the basic components. +A basic example as above is available in [`getting_started/index.html`](getting_started/index.html). Also, there are various samples in the `workbench` folder that are intended to exercise the basic components. ## Runtime Concepts -### Switches +### Configuration switches -Toolkit supports runtime options which are settable via the script tag that loads `platform.js`, or as query parameters. The most useful option at the moment is `log` which controls console output. +Toolkit supports runtime options which are settable via the ` +*Controls console output.* -Example of setting log output via url: +Example: - http://localhost/toolkitchen/toolkit/getting_started/?log=bind,ready + -At the moment, loggable topics include: +which is equivalent to: - bind: setup actions performed by the data-binding engine - data: runtime data transforms that result from bindings - watch: data change notifications - events: custom event bindings and event propagations - ready: a custom element reaching a ready state + http://localhost/toolkitchen/toolkit/getting_started/?log=bind,ready -It is also possible to select a specific Shadow DOM implementation via the `shadow` option. Shadow options include: +Loggable items include: - shim: required for Toolkit components (default) - webkit: native webkit implementation - polyfill: experimental polyfill for non-webkit browsers + + + + + + + + + + + + + + + + + + + +
valuedescription
bindsetup actions performed by the data-binding engine
dataruntime data transforms that result from bindings
watchdata change notifications
eventscustom event bindings and event propagations
readya custom element reaching a ready state
+ +#### shadow + +*Selects a specific Shadow DOM implementation.* + +Example: + + + +Possible values include: + + + + + + + + + + + + + + +
valuedescription
shimrequired for Toolkit components (default)
webkitnative webkit implementation
polyfillexperimental polyfill for non-webkit browsers
### Shadow DOM Shim @@ -72,4 +110,3 @@ Toolkit platform shims the Custom DOM Element Loader (``) ### Toolkit and G-Component All Toolkit components depend on `src/g-component.html` which provides the Toolkit sugaring layer (+see link to Toolkit syntax sugaring information). However, one can load `platform.js` and take advantage of the raw Custom Element and Shadow DOM support directly. See `toolkitchen/projects/CustomElementPlayground` for examples. -