diff --git a/assets/template-basic.png b/assets/template-basic.png new file mode 100644 index 0000000..ba9ef7d Binary files /dev/null and b/assets/template-basic.png differ diff --git a/templates/basic/README.md b/templates/basic/README.md index c35bcf0..b479c20 100644 --- a/templates/basic/README.md +++ b/templates/basic/README.md @@ -1,42 +1,26 @@ -# Nitro Minimal Starter +# McFly Starter Project -Look at the [Nitro documentation](https://nitro.unjs.io/) to learn more. +**McFly** is a no-framework framework that assists in leveraging the web platform -## Setup - -Make sure to install the dependencies: - -```bash -# npm -npm install - -# yarn -yarn install - -# pnpm -pnpm install ``` - -## Development Server - -Start the development server on - -```bash -npm run dev +npm create mcfly@latest ``` +![template-basic](https://raw.githubusercontent.com/ayoayco/McFly/main/assets/template-basic.png) -## Production +## Features +- Create web apps with vanilla custom elements +- Write real .HTML files +- Have no frameworks or reactivity libraries on the browser +- Use server-side rendering +- Deploy anywhere -Build the application for production: +## Special directories +**1. `src/pages`** +- file based routing for `.html` files +- directly use custom elements & static fragments (no imports or registry maintenance needed) +- use `