From da466620070b314edf83bda64556b148c7d70d4e Mon Sep 17 00:00:00 2001 From: Ian MacLeod Date: Fri, 31 Oct 2014 12:54:43 -0700 Subject: [PATCH] Update the readme to include @addyosmani's notes --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index cc7e86e..69ad92b 100644 --- a/README.md +++ b/README.md @@ -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.