Skip to content

Add placeholder in README for documenting exports #147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ef4 merged 1 commit into from
Jun 16, 2026
Merged

Add placeholder in README for documenting exports #147

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions files/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,16 @@ ember install <%= name %>

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

> TODO: Document the package's public API.
>
> For each public api (including components, helpers, modifiers, and other apis) include:
>
> - The import path for a consumer (e.g. `import MyAddonsComponent from 'my-addon/components/my-addons-component'`)
> - What it does
> - Parameters/options
> - Return value
> - Example usage

## Contributing

See the [Contributing](CONTRIBUTING.md) guide for details.
Expand Down
Loading