From bea5cc039dfc8919c0c4e3a6fc268f87c01f998f Mon Sep 17 00:00:00 2001 From: Ayo Date: Sat, 21 Oct 2023 20:35:43 +0200 Subject: [PATCH] chore: remove setting up in readme: create script preferred --- README.md | 29 ----------------------------- 1 file changed, 29 deletions(-) diff --git a/README.md b/README.md index 66521b8..d177935 100644 --- a/README.md +++ b/README.md @@ -39,34 +39,6 @@ The time has come for vanilla Web tech to be great again. 🎉 - all components are automatically registered using their file names; a `hello-world.js` component can be used as `` - static `.html` fragments; a `my-header.html` fragment can be directly used as `` -## Setting up - -In this project, we maintain several node workspaces in directories `./packages`, `./site`, and `./templates`. - -You can experience the framework now by cloning the project and playing with the example files in the [special directories](#special-directories) for the landing page (`./site/src`). - -Do the following steps to get you started: - -1. clone project and go into the directory -``` -git clone https://github.com/ayoayco/mcfly.git -``` -``` -cd mcfly -``` - -2. install deps -``` -npm i -``` - -3. run the dev server -``` -npm start -``` - -4. open the browser to `https://localhost:3000` (or what the dev server said) - ## McFly config To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts @@ -80,7 +52,6 @@ export default defineConfig({ ``` - ## More info This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [**Nitro**](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [**Web Component Base**](https://ayco.io/n/web-component-base) class.