update documentation

mel-miller · Sep 12, 2022 · a3049c2 · a3049c2
1 parent 984c013
commit a3049c2
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## [Unreleased]
 
+- Update documentation.
+
 ## [v0.1.1] - 2022-09-12
 
 - Add `behaviors` to naming convention of component-specific js.

diff --git a/README.md b/README.md
@@ -24,4 +24,10 @@ This generator should be run from the root of your project.
 yo sb-drupal:component
 ```
 
-Follow the prompts and a new component will be created in the proper directory within your `src` directory.
+Follow the prompts and a new directory will be created within the proper category directory in `src`. The new directory will contain the following starter files:
+
+- `{component-name}.stories.js`
+- `{component-name}.twig`
+- `_{component-name}.scss`
+- `{component-name}.docs.mdx`
+- `{component-name}.behaviors.js` (if selected)