diff --git a/aio/tools/plunker-builder/README.md b/aio/tools/plunker-builder/README.md index 77966ee47e..41c119aa3a 100644 --- a/aio/tools/plunker-builder/README.md +++ b/aio/tools/plunker-builder/README.md @@ -1,10 +1,54 @@ # Overview -In the AIO application, we can embed a running version of the example as a [Plunker](http://plnkr.co/). We can also provide a -link to create a runnable version of the example in the [Plunker](http://plnkr.co/edit) editor. +[Plunker](http://plnkr.co) is an online tool for creating, collaborating and sharing ideas. In AIO we use it to share one or more runnable versions of our examples. -This folder contains three utilities: +Plunker comes in two flavours. The [classic UI](http://plnkr.co/edit) and a [embedded UI](http://embed.plnkr.co). The latter can be used both in a new tab or embedded within a guide. The AIO project uses the embedded version in both ways. -* regularPlunker.js - generates an HTML file for each example that will post to Plunker to create a new editable project, when rendered. -* embeddedPlunker.js - generates an HTML file for each example that can be used in an iframe to render an embedded Plunker project. -* generatePlunkers.js - executes each of the `regularPlunker.js` and `embeddedPlunker.js` utilities to generate all the example plunker files. +## Plunker generation + +Both flavours are created within `builder.js`. How is a plunker created? What is the process from a directory with files to a link with a plunker. + +An "executable" plunker is an HTML file with a `