diff --git a/README.md b/README.md index c4d4111..43849ed 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,24 @@ This is a Proof of Concept and testing ground for using [Nitro](https://nitro.unjs.io) and vanilla JS custom elements using my [Web Component Base](https://ayco.io/n/web-component-base) class. +## Ambitious Goals +We want a way to: +1. create web apps with vanilla custom elements +1. write real .HTML files +1. no frameworks or reactivity libraries on the browser +1. easy server APIs authoring +1. server-side pre-rendering +1. control on when and where JS is downloaded for interactive elements + +## Special directories +**1. `src/pages`** +- file based routing for `.html` files +- directly use custom elements (no registry maintenance needed) + +**2. `src/components`** +- custom element constructor class files go here (only `.js` files for now) +- all components are automatically registered using their file names (e.g., a `hello-world.js` component can be used as `` element) + ## Setting up Do the following steps to get you started: @@ -26,25 +44,9 @@ npm run dev 4. open the browser to `https://localhost:3000` (or what the dev server said) -## Special directories -**src/pages** -- file based routing for `.html` files - -**src/components** -- custom element constructor class files go here (only `.js` files for now) -- all components are automatically registered using their file names (e.g., a `hello-world.js` component can be used as `` element) -## Ambitious Goals -We want a way to: -1. create web apps with vanilla custom elements -1. write real .HTML files -1. no frameworks or reactivity libraries on the browser -1. easy server APIs authoring -1. server-side pre-rendering -1. control on when and where JS is downloaded for interactive elements - ## More info This project was generated from Nitro starter guide. Look at the [Nitro documentation](https://nitro.unjs.io/) to learn more.