diff --git a/templates/basic/README.md b/templates/basic/README.md index f7941c5..e44cc8e 100644 --- a/templates/basic/README.md +++ b/templates/basic/README.md @@ -1,41 +1,60 @@ # McFly Starter Project -**McFly** is a no-framework framework that assists in leveraging the web platform. + +![template-basic](https://raw.githubusercontent.com/ayoayco/McFly/main/assets/template-basic.png) + +## Background +This project was generated from the basic template for **McFly** -- a no-framework framework that assists in leveraging the web platform. ``` npm create mcfly@latest ``` -![template-basic](https://raw.githubusercontent.com/ayoayco/McFly/main/assets/template-basic.png) + +It contains example files to get you started using vanilla web technologies in a modern way. See the [Special Directories](#special-directories) section for more information. ## 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 +The time has come for vanilla Web tech. 🎉 + +✅ 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
## Special directories -**1. `src/pages`** -- file based routing for `.html` files +**1. `./src/pages/`** +- file-based routing for `.html` files - directly use custom elements & static fragments (no imports or registry maintenance needed) - use `