From cd4b341a5fbf5044839fba1f2c01162cf09b7b4f Mon Sep 17 00:00:00 2001 From: Ayo Date: Thu, 11 Jan 2024 21:18:45 +0100 Subject: [PATCH] refactor(templates): clean the basic template - remove author info - simplify readme - clean package info --- templates/basic/README.md | 31 ---------------------------- templates/basic/package.json | 8 ++----- templates/basic/src/pages/index.html | 4 ---- 3 files changed, 2 insertions(+), 41 deletions(-) diff --git a/templates/basic/README.md b/templates/basic/README.md index 6e1969a..d5f3151 100644 --- a/templates/basic/README.md +++ b/templates/basic/README.md @@ -1,23 +1,9 @@ # McFly Starter Project - - -## Background This project was generated from the basic template for **McFly** -- a no-framework framework that assists in leveraging the web platform. -![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 -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 @@ -34,18 +20,6 @@ The time has come for vanilla Web tech. 🎉 - e.g., `./routes/api/users.ts` can be accessed via `http:///api/users` - TypeScript or JavaScript welcome! -## McFly config - -To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts - -```js -import defineConfig from "./packages/define-config"; - -export default defineConfig({ - components: "js", -}); - -``` ## Commands The following commands are available to you on this project. Add more, or modify them as needed in your `./package.json` file. @@ -56,8 +30,3 @@ The following commands are available to you on this project. Add more, or modify | npm run prepare | Prepare the workspace | | npm run build | Locally generate the app's build files to `./output` | | npm run preview | Preview the built app locally | - - ---- -*Just keep building*
-*A project by [Ayo Ayco](https://ayco.io)* diff --git a/templates/basic/package.json b/templates/basic/package.json index a595c20..da8e5a2 100644 --- a/templates/basic/package.json +++ b/templates/basic/package.json @@ -1,6 +1,6 @@ { "name": "@templates/basic", - "description": "McFly starter project; see more on https://ayco.io/gh/McFly", + "description": "McFly starter project", "scripts": { "start": "mcfly serve", "prepare": "mcfly prepare", @@ -14,9 +14,5 @@ "@mcflyjs/config": "latest", "@mcflyjs/core": "latest", "nitropack": "latest" - }, - "version": "0.0.1", - "main": "index.js", - "author": "Ayo Ayco", - "license": "MIT" + } } diff --git a/templates/basic/src/pages/index.html b/templates/basic/src/pages/index.html index bc5c568..34bf4f0 100644 --- a/templates/basic/src/pages/index.html +++ b/templates/basic/src/pages/index.html @@ -11,10 +11,6 @@ name: "McFly", description: "Back to the Basics. Into the Future." }; - const author = { - name: "Ayo Ayco", - url: "https://ayco.io" - }