Skip to content

Commit

Permalink
docs: add note about needing ember-auto-import
Browse files Browse the repository at this point in the history
Related to discussion in #14
  • Loading branch information
alexlafroscia committed Jan 29, 2020
1 parent 31e0554 commit d41e67f
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ Stencil provides a great, opinionated process for defining Web Components (custo
Start by installing your Stencil components as `npm` modules, as described in the [distribution instructions][distribution] in the guide. Then, install this addon:

```bash
ember install ember-cli-stencil
ember install ember-cli-stencil ember-auto-import
```

That's it! Your Stencil components will automatically be detected by the addon and pulled into your application.

**Note:** `ember-auto-import` is _required_ for this addon to work correctly.

## Usage

Since Stencil components are detected automatically, you can just start using any Stencil components discovered in your dependencies without any further configuration required. Props can be passed to them, just like other elements, and events listened to through the [`{{on}}` modifier][on-modifier].
Expand Down

0 comments on commit d41e67f

Please sign in to comment.