From 6281c1516fe5231523b61d511254d0c31fa62269 Mon Sep 17 00:00:00 2001
From: ayo
Date: Sat, 7 Jun 2025 23:33:58 +0200
Subject: [PATCH] chore: housekeeping (#60)
* chore: remove .build.yml
* chore: update attribution
---
.build.yml | 38 ------------------------------
README.md | 19 +++++++--------
packages/config/README.md | 2 +-
packages/core/README.md | 2 +-
packages/create-mcfly/README.md | 2 +-
site/README.md | 2 +-
site/src/components/my-footer.html | 2 +-
7 files changed, 14 insertions(+), 53 deletions(-)
delete mode 100644 .build.yml
diff --git a/.build.yml b/.build.yml
deleted file mode 100644
index f070b8d..0000000
--- a/.build.yml
+++ /dev/null
@@ -1,38 +0,0 @@
-image: alpine/edge
-packages:
- - nodejs
- - npm
- - pnpm
-secrets:
- - 34883663-8684-41cb-9920-8e96345ef166
- - bbfcb6dc-7c4a-42ee-a11a-022f0339a133
-environment:
- NETLIFY_SITE_ID: 390b392a-a898-491b-8500-79aa30f724d6
- GH_USER: ayoayco
- REPO: mcfly
-tasks:
- - push-mirror: |
- cd ~/"${REPO}"
- git config --global credential.helper store
- git push --mirror "https://github.com/${GH_USER}/${REPO}"
- - install-deps: |
- cd ~/"${REPO}"
- pnpm i --ignore-scripts
- - test: |
- cd ~/"${REPO}"
- npx vitest run
- - build: |
- cd ~/"${REPO}"
- pnpm -F ./packages/core build
- pnpm -F ./packages/config build
- pnpm -F site i --ignore-scripts
- pnpm -F site build
- - deploy: |
- cd mcfly
- {
- set +x
- . ~/.buildsecrets
- set -x
- }
- export NETLIFY_AUTH_TOKEN
- pnpm -F site run deploy
diff --git a/README.md b/README.md
index d1767d8..9aab60d 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,6 @@
-
## Why
I often wonder what it would look like to build sites & apps knowing just the basics.
@@ -23,7 +22,7 @@ I thought:
- What if I can write [HTML fragments](https://developer.mozilla.org/en-US/docs/Web/API/DocumentFragment) and [assemble them](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_shadow_DOM) 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.
+**McFly** is my reimagination of web development: *Back to the basics. Into the future.*
## Project Status
@@ -43,7 +42,7 @@ npm create mcfly@latest
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.
+The idea is to have a plugin system which allows for the core functionality to only "lean" on web platform features. Anything not yet a standard is implemented as a plugin which will be easily "swapped" away when the platform catches up.
## Features
@@ -76,11 +75,11 @@ A plugin system allows for the core functionality to only "lean" on platform. An
The following are the project packages published on the NPM registry:
-| Package | Description | Version |
-| ------------------------------------------------------ | -------------------------------------------- | ---------------------------------------------------------------- |
+| Package | Description | Version |
+| :----------------------------------------------------- | -------------------------------------------- | ------------------------------------------------------------ |
| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects |  |
-| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Route event and config handlers |  |
-| [`create-mcfly`](https://ayco.io/n/create-mcfly) | Script for scaffolding a new McFly workspace |  |
+| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Route event and config handlers |  |
+| [`create-mcfly`](https://ayco.io/n/create-mcfly) | Script for scaffolding a new McFly workspace |  |
## Project setup
@@ -94,7 +93,7 @@ pnpm i
The following commands are available to you on this project. Add more, or modify them as needed in your `./package.json` file.
| Command | Action |
-| ----------------------- | ----------------------------------------------------- |
+| ----------------------- | :---------------------------------------------------- |
| pnpm run site | Start the development server for https://mcfly.js.org |
| pnpm run template:basic | Start the development server for the basic template |
| pnpm run build | Locally generate the app's build files to `./output` |
@@ -108,5 +107,5 @@ This framework is a result of [an exploration](https://social.ayco.io/@ayo/11119
---
-_Just keep building_
-_A project by [Ayo Ayco](https://ayo.ayco.io)_
+*Just keep building.*
+*A project by [Ayo](https://ayo.ayco.io)*
diff --git a/packages/config/README.md b/packages/config/README.md
index 184da16..89f9fb1 100644
--- a/packages/config/README.md
+++ b/packages/config/README.md
@@ -85,4 +85,4 @@ This framework is a result of [an exploration](https://social.ayco.io/@ayo/11119
---
_Just keep building_
-_A project by [Ayo Ayco](https://ayco.io)_
+_A project by [Ayo](https://ayco.io)_
diff --git a/packages/core/README.md b/packages/core/README.md
index 184da16..89f9fb1 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -85,4 +85,4 @@ This framework is a result of [an exploration](https://social.ayco.io/@ayo/11119
---
_Just keep building_
-_A project by [Ayo Ayco](https://ayco.io)_
+_A project by [Ayo](https://ayco.io)_
diff --git a/packages/create-mcfly/README.md b/packages/create-mcfly/README.md
index dadfb9f..20dbd69 100644
--- a/packages/create-mcfly/README.md
+++ b/packages/create-mcfly/README.md
@@ -67,4 +67,4 @@ This framework is a result of [an exploration](https://social.ayco.io/@ayo/11119
---
_Just keep building_
-_A project by [Ayo Ayco](https://ayco.io)_
+_A project by [Ayo](https://ayco.io)_
diff --git a/site/README.md b/site/README.md
index 4d64d3e..c29c761 100644
--- a/site/README.md
+++ b/site/README.md
@@ -47,4 +47,4 @@ export default defineConfig({
---
_Just keep building_
-_A project by [Ayo Ayco](https://ayco.io)_
+_A project by [Ayo](https://ayco.io)_
diff --git a/site/src/components/my-footer.html b/site/src/components/my-footer.html
index 192060f..0ffd60e 100644
--- a/site/src/components/my-footer.html
+++ b/site/src/components/my-footer.html
@@ -1,5 +1,5 @@