Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(746)

Unified Diff: pkg/html_import/README.md

Issue 20414002: Create package for HTML imports (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Created 7 years, 5 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | pkg/html_import/lib/html_import.debug.js » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: pkg/html_import/README.md
diff --git a/pkg/html_import/README.md b/pkg/html_import/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..c394a6ef80ba2e627f117662239e510413d0050d
--- /dev/null
+++ b/pkg/html_import/README.md
@@ -0,0 +1,43 @@
+# HTML Imports polyfill
+
+[HTML Imports][1] are a way to include and reuse HTML documents in other HTML
+documents. As `<script>` tags let authors include external Javascript in their
+pages, imports let authors load full HTML resources. In particular, imports let
+authors include [Custom Element](https://github.com/Polymer/CustomElements)
+definitions from external URLs.
+
+
+## Getting Started
+
+Include the `html_import.debug.js` or `html_import.min.js` (minified) file in
+your project.
+
+ <script src="packages/html_import/html_import.debug.js"></script>
+
+`html_import.debug.js` is the debug loader and uses `document.write` to load
+additional modules.
+
+Use the minified version (`html_import.min.js`) if you need to load the file
+dynamically.
+
+## Basic usage
+
+For HTML imports use the `import` relation on a standard `<link>` tag, for
+example:
+
+ <link rel="import" href="import-file.html">
+
+## Polyfill details
+
+You can read more about how the polyfill is implemented in JavaScript here:
+<https://github.com/Polymer/HTMLImports/tree/master#polyfill-details>
+
+## Getting the source code
+
+This package is built from:
+<https://github.com/Polymer/HTMLImports/tree/master>
+
+You'll need [node.js](http://nodejs.org) to rebuild the JS file. Use
+`npm install` to get dependencies and `grunt` to build.
+
+[1]: https://dvcs.w3.org/hg/webcomponents/raw-file/tip/spec/imports/index.html
« no previous file with comments | « no previous file | pkg/html_import/lib/html_import.debug.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698