ayo/mcfly
ayo/mcfly
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme with 'how it works'

Browse source
This commit is contained in:
Ayo Ayco 2025-03-01 10:44:20 +01:00
parent 42ebbb6d1b
commit 92c17b475b
1 changed files with 6 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -7,7 +7,7 @@
<h1 align="center">McFly</h1> <h1 align="center">McFly</h1>
<p align="center"><strong>McFly</strong> is a no-framework metaframework<br />that assists in leveraging the web platform</p> <p align="center"><strong>McFly</strong> is a metaframework<br />that assists in leveraging the web platform</p>
<p align="center"> <p align="center">
<img src="https://img.shields.io/badge/from-the_future-blue?style=flat" /> <img src="https://img.shields.io/badge/from-the_future-blue?style=flat" />
@ -42,6 +42,11 @@ Run the following to generate a McFly starter project.
npm create mcfly@latest npm create mcfly@latest
``` ```
## How it works (for the nerds)
It is primarily a runtime middleware for [Nitro](https://nitro.build). Every time a page is requested, the McFly middleware intercepts and assembles the view for the requestor. McFly does this with the assets it knows about which are mostly: pages, components, public assets.
A plugin system allows for the core functionality to only "lean" on platform. Anything not yet a standard is implemented as a plugin which will be easily "swapped" away when the platform catches up.
## Features ## Features