diff --git a/README.md b/README.md index a66483e..3e22cae 100644 --- a/README.md +++ b/README.md @@ -32,10 +32,10 @@ src/ <-- your source code css/ <-- processed css files js/ <-- processed javascript files public/ <-- unprocessed static `/` assets - pages/ <-- page components + components/ <-- riots components hello-riot/ hello-riot.riot <-- riot component - hello-riot.spec.js <-- component test + hello-riot.spec.js <-- component tests index.js <-- application bootstrap index.html <-- START HERE vite.config.js <-- build configuration @@ -45,11 +45,12 @@ README.md ### Mounting Strategy -This template uses a static component mounting registry to mount global **pages** (components) which in-turn mounts content specific components to flesh out your pages using `components` export option. +This template uses a static registry to mount global **components** which in-turn can mount other nested components via `components` export option. #### Components Example ``` +// my-page.riot
@@ -76,7 +77,7 @@ In a folder-per-component setup, you can place your `*.spec.js` files right next *bring your own testing solution* -> CHAI/MOCHA EXAMPLE: `src/pages/hello-riot/hello-riot.spec.js` (unwired) +> CHAI/MOCHA EXAMPLE: `src/components/hello-riot/hello-riot.spec.js` (unwired) ## NPM Scripts diff --git a/src/pages/hello-riot/hello-riot.riot b/src/components/hello-riot/hello-riot.riot similarity index 88% rename from src/pages/hello-riot/hello-riot.riot rename to src/components/hello-riot/hello-riot.riot index 12fd472..8ba695d 100644 --- a/src/pages/hello-riot/hello-riot.riot +++ b/src/components/hello-riot/hello-riot.riot @@ -11,16 +11,16 @@

Getting Started

- This page is found at src/pages/hello-riot/hello-riot.riot, + This page is found at src/components/hello-riot/hello-riot.riot,
and is statically mounted via src/js/registry.js.

- many mounting strategies exist, this is but one! + many mounting strategies exist, this is but one

Documentation

-