Add migration guide to README.md

README.md

@@ -3,7 +3,9 @@
 ![build](https://github.com/mrmans0n/compose-rules/actions/workflows/build.yaml/badge.svg) ![Latest version](https://img.shields.io/maven-central/v/io.nlopez.compose.rules/common)
 
 > **Note**
-> This repository is a fork of the [Twitter Jetpack Compose Rules](https://github.com/twitter/compose-rules) by its original maintainer. As none of the admins/maintainers continue working at the company, its development will continue here from now on.
+> This repository is a fork of the [Twitter Jetpack Compose Rules](https://github.com/twitter/compose-rules) by its original maintainer. As none of the admins/maintainers continue working at the company, its development will continue here from now on. If you come from that project, check out the [migration guide](https://mrmans0n.github.io/compose-rules/).
+
+## Overview
 
 It can be challenging for big teams to start adopting Compose, particularly because not everyone will start at same time or with the same patterns. We tried to ease the pain by creating a set of Compose static checks.
 

docs/index.md

@@ -14,3 +14,14 @@ You can refer to the [Using with ktlint](https://mrmans0n.github.io/compose-rule
 ## Using with Detekt
 
 You can refer to the [Using with Detekt](https://mrmans0n.github.io/compose-rules/detekt) documentation.
+
+## Migrating from Twitter Compose Rules
+
+The process to migrate to these rules coming from the Twitter ones is simple.
+
+1) Change the project coordinates in your gradle build scripts
+   1) For Detekt, `com.twitter.compose.rules:detekt:$version` becomes `io.nlopez.compose.rules:detekt:$version`
+   2) For Ktlint, `com.twitter.compose.rules:ktlint:$version` becomes `io.nlopez.compose.rules:ktlint:$version`.
+2) Update `$version` to the latest: ![Latest version](https://img.shields.io/maven-central/v/io.nlopez.compose.rules/common) - see the project [releases page](https://github.com/mrmans0n/compose-rules/releases).
+3) **If you are using Detekt**: update the config file (e.g. `detekt.yml`) so that the rule set name `TwitterCompose` becomes `Compose`. Keep in mind that there are a lot of new rules in this repo that weren't in Twitter's, so you'd be better copying over from the [example configuration](https://mrmans0n.github.io/compose-rules/detekt).
+4) Done!