chore(packages): update packages readme
This commit is contained in:
Ayo
parent
d341de9179
commit
3e1ca3b1a6
3 changed files with 31 additions and 19 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
Loading…
Reference in a new issue