diff --git a/files/README.md b/files/README.md index 829d598..e2849f2 100644 --- a/files/README.md +++ b/files/README.md @@ -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.