Update the readme to include @addyosmani's notes

This commit is contained in:
Ian MacLeod
2014-10-31 12:54:43 -07:00
parent 38f31ce11c
commit da46662007

View File

@@ -1,7 +1,21 @@
webcomponents.js-dev
====================
webcomponents.js
================
Web Component polyfills development respository.
A suite of polyfills supporting the HTML web components specs:
Production distributions may be built using gulp. Pre-built versions are
available at https://github.com/Polymer/webcomponentsjs.
**Custom Elements**: allows authors to define their own custom tags ([spec](https://w3c.github.io/webcomponents/spec/custom/)).
**HTML Imports**: a way to include and reuse HTML documents via other HTML documents ([spec](https://w3c.github.io/webcomponents/spec/imports/)).
**Shadow DOM**: provides encapsulation by hiding DOM subtrees under shadow roots ([spec](https://w3c.github.io/webcomponents/spec/shadow/)).
This also folds in polyfills for `MutationObserver` and `WeakMap`.
# Builds
There are two builds of these polyfills:
`webcomponents.js` includes all of the polyfills.
`webcomponents-lite.js` includes all polyfills except for shadow DOM.