tudisco/parcel-transformer-riot
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

updated: documentation

Browse Source
This commit is contained in:
gianlucaguarini 2021-10-16 19:34:45 +02:00
parent 4ee51ea76f
commit 12829a45a8
2 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Readme.md
View File

@ -7,13 +7,26 @@ A parcel plugin for riot.js
## Important
If you are using Riot.js < 4.0.0 please check the [v3 branch](https://github.com/riot/parcel-plugin-riot/tree/v3)
- If you are using Parcel < 1.0.0 please check the [this branch](https://github.com/riot/parcel-transformer-riot/tree/parcel-v1)
- If you are using Riot.js < 4.0.0 please check the [v3 branch](https://github.com/riot/parcel-transformer-riot/tree/v3)
## Using
Add parcel-plugin-riot to your project.
### 1. Add the riot parcel transformer to your project.
```bash
npm i -D @riotjs/parcel-plugin-riot @riotjs/compiler
npm i -D @riotjs/parcel-transformer-riot @riotjs/compiler
```
### 2. Configure your .parcelrc file
```json
{
"extends": "@parcel/config-default",
"transformers": {
"*.riot": ["@riotjs/parcel-transformer-riot"]
}
}
```
-> You are ready!
@ -70,13 +83,13 @@ npm i @riotjs/hot-reload -D
```
[ci-image]:https://img.shields.io/github/workflow/status/riot/parcel-plugin-riot/test?style=flat-square
[ci-url]:https://github.com/riot/parcel-plugin-riot/actions
[ci-image]:https://img.shields.io/github/workflow/status/riot/parcel-transformer-riot/test?style=flat-square
[ci-url]:https://github.com/riot/parcel-transformer-riot/actions
[license-image]: https://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
[license-url]: LICENSE
[npm-version-image]: https://img.shields.io/npm/v/@riotjs/parcel-plugin-riot.svg?style=flat-square
[npm-downloads-image]: https://img.shields.io/npm/dm/@riotjs/parcel-plugin-riot.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@riotjs/parcel-plugin-riot
[npm-version-image]: https://img.shields.io/npm/v/@riotjs/parcel-transformer-riot.svg?style=flat-square
[npm-downloads-image]: https://img.shields.io/npm/dm/@riotjs/parcel-transformer-riot.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@riotjs/parcel-transformer-riot

2
package.json
View File

@ -14,7 +14,7 @@
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/andruschka/parcel-plugin-riot"
"url": "https://github.com/riot/parcel-plugin-riot"
},
"peerDependencies": {
"@riotjs/compiler": "^6.0.0"