Skip to content

Commit 846c095

Browse files
authored
Add placeholder for documenting exports from an addon
Towards advancing [RFC ember-cli#779](emberjs/rfcs#1059)
1 parent 8458a0a commit 846c095

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

packages/addon-blueprint/files/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,16 @@ ember install <%= addonName %>
1818

1919
[Longer description of how to use the addon in apps.]
2020

21+
> TODO: Document the package's public API.
22+
>
23+
> For each public api (including components, helpers, modifiers, and other apis) include:
24+
>
25+
> - The import path for a consumer (e.g. `import MyAddonsComponent from 'my-addon/components/my-addons-component'`)
26+
> - What it does
27+
> - Parameters/options
28+
> - Return value
29+
> - Example usage
30+
2131
## Contributing
2232

2333
See the [Contributing](CONTRIBUTING.md) guide for details.

0 commit comments

Comments
 (0)