From f2926ff99b066a2d078987a3979f2e6dc6544e20 Mon Sep 17 00:00:00 2001
From: Katie Gengler <katie@kmg.io>
Date: Tue, 16 Jun 2026 12:18:49 -0400
Subject: [PATCH] Add placeholder in README for documenting exports

Towards advancing [RFC #779](https://github.com/emberjs/rfcs/pull/1059/)
---
 files/README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/files/README.md b/files/README.md
index 829d5981..e2849f2b 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.