diff --git a/README.md b/README.md index dc8aa8c..fcbca20 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@

McFly

-

McFly is a no-framework framework
that assists in leveraging the web platform

+

McFly is a no-framework metaframework
that assists in leveraging the web platform

@@ -24,23 +24,22 @@ I thought: **McFly** is my reimagination of web development: Back to the basics. Into the future. -## Project Status -We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases. +## Project Status +We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases. -## Installation +## Try it today Run the following to generate a McFly starter project. ``` npm create mcfly@latest ``` ## 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 vanilla custom elements (or sugar-coated web components)
+βœ… Write server-powered .html pages
+βœ… "Use the Platformβ„’" on both server runtimes & browsers βœ… Use server-side rendering
-βœ… Deploy anywhere
+βœ… Deploy anywhere, even the Edge
## Special directories **1. `./src/pages/`** diff --git a/packages/config/README.md b/packages/config/README.md index 001c14b..fcbca20 100644 --- a/packages/config/README.md +++ b/packages/config/README.md @@ -4,29 +4,42 @@

McFly

-

McFly is a no-framework framework
that assists in leveraging the web platform

+

McFly is a no-framework metaframework
that assists in leveraging the web platform

- +

-## Installation +## Why -Run the following to generate a McFly starter project: +I often wonder what it would look like to build sites & apps knowing just the basics. + +I thought: +- What if I knew how to write HTML and I can have a dynamic web page from that? +- What if I knew how to build custom elements and that's all the component system I needed? +- What if I can write HTML fragments and assemble them easily in a page? +- What if I did not have to worry about the [ever-growing number of ways to have a place on the Web](https://ayos.blog/places-in-the-web/)? + +**McFly** is my reimagination of web development: Back to the basics. Into the future. + +## Project Status +We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases. + +## Try it today +Run the following to generate a McFly starter project. ``` npm create mcfly@latest ``` ## 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 vanilla custom elements (or sugar-coated web components)
+βœ… Write server-powered .html pages
+βœ… "Use the Platformβ„’" on both server runtimes & browsers βœ… Use server-side rendering
-βœ… Deploy anywhere
+βœ… Deploy anywhere, even the Edge
## Special directories **1. `./src/pages/`** @@ -44,23 +57,20 @@ 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 +## Packages +The following are the project packages published on the NPM registry: -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", -}); - -``` +| Package | Description | Version | +| --- | --- | --- | +| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli) | The McFly CLI tooling | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli) | +| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) | +| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Route event and config handlers | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore) | +| [`create-mcfly`](https://ayco.io/n/create-mcfly) | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly) | ## 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://WebComponent.io) class. +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://WebComponent.io) class. -**Nitro** is the same production-grade web server powering [**Nuxt**](https://nuxt.com/) +**Nitro** is the same production-grade web server powering [Nuxt](https://nuxt.com/) --- *Just keep building*
diff --git a/packages/core/README.md b/packages/core/README.md index 001c14b..fcbca20 100644 --- a/packages/core/README.md +++ b/packages/core/README.md @@ -4,29 +4,42 @@

McFly

-

McFly is a no-framework framework
that assists in leveraging the web platform

+

McFly is a no-framework metaframework
that assists in leveraging the web platform

- +

-## Installation +## Why -Run the following to generate a McFly starter project: +I often wonder what it would look like to build sites & apps knowing just the basics. + +I thought: +- What if I knew how to write HTML and I can have a dynamic web page from that? +- What if I knew how to build custom elements and that's all the component system I needed? +- What if I can write HTML fragments and assemble them easily in a page? +- What if I did not have to worry about the [ever-growing number of ways to have a place on the Web](https://ayos.blog/places-in-the-web/)? + +**McFly** is my reimagination of web development: Back to the basics. Into the future. + +## Project Status +We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases. + +## Try it today +Run the following to generate a McFly starter project. ``` npm create mcfly@latest ``` ## 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 vanilla custom elements (or sugar-coated web components)
+βœ… Write server-powered .html pages
+βœ… "Use the Platformβ„’" on both server runtimes & browsers βœ… Use server-side rendering
-βœ… Deploy anywhere
+βœ… Deploy anywhere, even the Edge
## Special directories **1. `./src/pages/`** @@ -44,23 +57,20 @@ 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 +## Packages +The following are the project packages published on the NPM registry: -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", -}); - -``` +| Package | Description | Version | +| --- | --- | --- | +| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli) | The McFly CLI tooling | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli) | +| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) | +| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Route event and config handlers | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore) | +| [`create-mcfly`](https://ayco.io/n/create-mcfly) | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly) | ## 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://WebComponent.io) class. +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://WebComponent.io) class. -**Nitro** is the same production-grade web server powering [**Nuxt**](https://nuxt.com/) +**Nitro** is the same production-grade web server powering [Nuxt](https://nuxt.com/) --- *Just keep building*