Skip to content

Commit 94655ff

Browse files
authored
Merge pull request #147 from ember-cli/kategengler-patch-1
Add placeholder in README for documenting exports
2 parents 06daded + f2926ff commit 94655ff

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

files/README.md

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

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

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

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

0 commit comments

Comments
 (0)