neyric/wireit

View on GitHub
src/common/docs/partials/getting-started.mustache

Summary

Maintainability
Test Coverage
<h2>Getting Started</h2>

<p>
To include the source files for {{displayName}} and its dependencies, first load
the YUI seed file, the WireIt seed file, and set the path to the WireIt <i>build</i> directory.
</p>

```
<script src="https://yui-s.yahooapis.com/{{{yuiVersion}}}/build/yui/yui-min.js"></script>
<script src="../../build/wireit-loader/wireit-loader.js"></script>
<script>YUI_config.groups.wireit.base = '../../build/';</script>
```

<p>
Next, create a new YUI instance for your application and populate it with the
modules you need by specifying them as arguments to the `YUI().use()` method.
YUI will automatically load any dependencies required by the modules you
specify.
</p>

```
<script>
// Create a new YUI instance and populate it with the required modules.
YUI().use({{{useParams}}}, function (Y) {
    // {{{displayName}}} is available and ready for use. Add implementation
    // code here.
});
</script>
```

<!--p>
For more information on creating YUI instances and on the
<a href="{{apiDocs}}/classes/YUI.html#method_use">`use()` method</a>, see the
documentation for the <a href="../yui/index.html">YUI Global Object</a>.
</p-->