Add usage instructions to version-sync's README

Splitties · Nov 10, 2023 · b270b2d · b270b2d
1 parent 2ad8e1b
commit b270b2d
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/gradle-plugins/version-sync/README.md b/gradle-plugins/version-sync/README.md
@@ -48,3 +48,13 @@ putVersionInCode(
  )
 )
 ```
+
+## How to add to your project
+
+Go in the `settings.gradle.kts` file, located at the root of your Gradle project.
+
+Add the following line into the `plugins { … }` block (add one at the top of the file it there's none):
+
+```gradle.kts
+ id("org.splitties.incubator.version-sync") version "0.2.6-SNAPSHOT"
+```