diff --git a/README.md b/README.md index 98f02cd..987b888 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ Use [Vite](https://vitejs.dev/) Starter Template to scaffold a new [Riot](https://riot.js.org/) project. + ## Getting Started Pull the template files with [degit](https://github.com/Rich-Harris/degit) and install dependencies @@ -14,6 +15,41 @@ npm install npm run dev ``` +### Mounting Strategy + +This template uses a **pages** static registry based approach that auto-mounts global *page components* that then can dynaimicly mount other *components* needed build your up your content via the `components` export default property. + +> SEE: /pages/registry.js for more information + +#### Components Example + +``` + +
+ +
+ + +
+``` + +> recommend a dedicated `/components` directory + +### Testing + +- TODO + +> SEE: `pages/hello-riot/hello-riot.spec.js` (unwired) + + ## NPM Scripts - npm run dev - Starts the development server at port 3000 @@ -34,6 +70,11 @@ When you use this template, you should update the following with your informatio - [ ] Clean up the README +## TODO + +- Add Testing Example w/ Chai & Mocha + + ## License - [MIT License](https://github.com/n2geoff/vite-riot-template/blob/main/LICENSE).