From 12829a45a8c804c1b5cee86dbb8e9b5abe2ba712 Mon Sep 17 00:00:00 2001
From: gianlucaguarini <gianluca.guarini@gmail.com>
Date: Sat, 16 Oct 2021 19:34:45 +0200
Subject: [PATCH] updated: documentation

---
 Readme.md    | 29 +++++++++++++++++++++--------
 package.json |  2 +-
 2 files changed, 22 insertions(+), 9 deletions(-)

diff --git a/Readme.md b/Readme.md
index f87cfa8..4e02b14 100644
--- a/Readme.md
+++ b/Readme.md
@@ -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
 
diff --git a/package.json b/package.json
index 60f0b72..82545e4 100644
--- a/package.json
+++ b/package.json
@@ -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"