From 3e1ca3b1a6c33a1f49197955df1353d0e21582a7 Mon Sep 17 00:00:00 2001
From: Ayo <ramon.aycojr@gmail.com>
Date: Wed, 25 Oct 2023 07:39:02 +0200
Subject: [PATCH] chore(packages): update packages readme

---
 packages/config/README.md       | 13 +++++++++----
 packages/core/README.md         | 11 ++++++++---
 packages/create-mcfly/README.md | 26 ++++++++++++++------------
 3 files changed, 31 insertions(+), 19 deletions(-)

diff --git a/packages/config/README.md b/packages/config/README.md
index 9d1e597..c5534b1 100644
--- a/packages/config/README.md
+++ b/packages/config/README.md
@@ -1,5 +1,5 @@
 <p align="center">
-  <img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="Rick & Morty cartoon" />
+  <img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="rRick & Morty cartoon" />
 </p>
 
 <h1 align="center">McFly</h1>
@@ -29,16 +29,21 @@ The time has come for vanilla Web tech. 🎉
 ✅ Deploy anywhere<br>
 
 ## Special directories
-**1. `src/pages`**
-- file based routing for `.html` files
+**1. `./src/pages/`**
+- file-based routing for `.html` files
 - directly use custom elements & static fragments (no imports or registry maintenance needed)
 - use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
 
-**2. `src/components`**
+**2. `./src/components/`**
 - custom element constructor files (only `.js` files for now)
 - all components are automatically registered using their file names; a `hello-world.js` component can be used as `<hello-world>`
 - static `.html` fragments; a `my-header.html` fragment can be directly used as `<my-header>`
 
+**3. `./routes/api/`**
+- file-based routing for REST API endpoints
+- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/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
diff --git a/packages/core/README.md b/packages/core/README.md
index 3d3e9d1..c5534b1 100644
--- a/packages/core/README.md
+++ b/packages/core/README.md
@@ -29,16 +29,21 @@ The time has come for vanilla Web tech. 🎉
 ✅ Deploy anywhere<br>
 
 ## Special directories
-**1. `src/pages`**
-- file based routing for `.html` files
+**1. `./src/pages/`**
+- file-based routing for `.html` files
 - directly use custom elements & static fragments (no imports or registry maintenance needed)
 - use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
 
-**2. `src/components`**
+**2. `./src/components/`**
 - custom element constructor files (only `.js` files for now)
 - all components are automatically registered using their file names; a `hello-world.js` component can be used as `<hello-world>`
 - static `.html` fragments; a `my-header.html` fragment can be directly used as `<my-header>`
 
+**3. `./routes/api/`**
+- file-based routing for REST API endpoints
+- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/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
diff --git a/packages/create-mcfly/README.md b/packages/create-mcfly/README.md
index 9d1e597..bed4fba 100644
--- a/packages/create-mcfly/README.md
+++ b/packages/create-mcfly/README.md
@@ -1,8 +1,12 @@
 <p align="center">
-  <img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="Rick & Morty cartoon" />
+  <img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="rRick & Morty cartoon" />
 </p>
 
-<h1 align="center">McFly</h1>
+<h1 align="center">Create McFly</h1>
+
+```
+npm create mcfly@latest
+```
 
 <p align="center"><strong>McFly</strong> is a no-framework framework<br />that assists in leveraging the web platform</p>
 
@@ -12,13 +16,6 @@
   <a href="https://mc-fly.vercel.app/demo" target="_blank"><img src="https://img.shields.io/badge/see-the_demo_↗️-blue?style=flat&colorB=28CF8D" /></a>
 </p>
 
-## Installation
-
-Run the following to generate a McFly starter project:
-```
-npm create mcfly@latest
-```
-
 ## Features
 The time has come for vanilla Web tech. 🎉
 
@@ -29,16 +26,21 @@ The time has come for vanilla Web tech. 🎉
 ✅ Deploy anywhere<br>
 
 ## Special directories
-**1. `src/pages`**
-- file based routing for `.html` files
+**1. `./src/pages/`**
+- file-based routing for `.html` files
 - directly use custom elements & static fragments (no imports or registry maintenance needed)
 - use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
 
-**2. `src/components`**
+**2. `./src/components/`**
 - custom element constructor files (only `.js` files for now)
 - all components are automatically registered using their file names; a `hello-world.js` component can be used as `<hello-world>`
 - static `.html` fragments; a `my-header.html` fragment can be directly used as `<my-header>`
 
+**3. `./routes/api/`**
+- file-based routing for REST API endpoints
+- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/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