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

chore: add Packages section to readme

Browse source
This commit is contained in:
Ayo 2023-10-25 23:53:00 +02:00
parent 371e9a371c
commit f135bd22a5
1 changed files with 9 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -62,8 +62,6 @@ Then, you can run the following **McFly CLI** commands:
| `mcfly prepare` | Prepares the McFly workspace. | | `mcfly prepare` | Prepares the McFly workspace. |
| `mcfly generate` | Generates building blocks for a McFly app. (In-progress) | | `mcfly generate` | Generates building blocks for a McFly app. (In-progress) |
## McFly config ## McFly config
To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts
@ -76,6 +74,15 @@ export default defineConfig({
}); });
``` ```
## Packages
The following are the project packages published on the NPM registry:
| Package | Description | Version |
| --- | --- | --- |
| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Core package containing event and configuration handlers | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore) |
| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Package containing the Nitro configuration for McFly projects | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) |
| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli) | The McFly CLI tooling | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli) |
| [`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 ## 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://ayco.io/n/web-component-base) 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://ayco.io/n/web-component-base) class.