updated documentation

Author: matrixdev

README.md

@@ -30,7 +30,9 @@ Add `androidRust` configuration
 
 ```kotlin
 androidRust {
-    path = file("src/rust_library") // path to your rust library
+    module("rust-library") {
+        path = file("src/rust_library")
+    }
 }
 ```
 
@@ -40,28 +42,54 @@ This is the list of some additional flags that can be configured:
 
 ```kotlin
 androidRust {
-    path = file("src/rust_library")
-
-    // default rust profile
-    profile = "release"
-
-    // default abi targets
-    targets = setOf("arm", "arm64")
-
     // MSRV, plugin will update rust if installed version is lower than requested
     minimumSupportedRustVersion = "1.62.1"
-
-    // "debug" build type specific configuration
-    buildType("debug") {
-        // use "dev" profile in rust
-        profile = "dev"
+    
+    module("rust-library") {
+        // path to your rust library
+        path = file("src/rust_library")
+
+        // default rust profile
+        profile = "release"
+
+        // default abi targets
+        targets = setOf("arm", "arm64")
+
+        // "debug" build type specific configuration
+        buildType("debug") {
+            // use "dev" profile in rust
+            profile = "dev"
+        }
+
+        // "release" build type specific configuration
+        buildType("release") {
+            // run rust tests before build
+            runTests = true
+
+            // build all supported abi versions
+            targets = setOf("arm", "arm64", "x86", "x86_64")
+        }
     }
 
-    // "release" build type specific configuration
-    buildType("release") {
-        // build all supported abi versions
-        targets = setOf("arm", "arm64", "x86", "x86_64")
+    // more than one library can be added 
+    module("additional-library") {
+        // ...
     }
 }
 ```
 
+# Development support
+
+Plugin will check for a magic property `android.injected.build.abi` set by Android Studio when
+running application on device. This will limit ABI targets to only required by the device and
+should speedup development quite a bit.
+
+In theory this should behave the same as a built-in support for the NdkBuild / CMake.
+
+# Goals
+- Building multiple rust libraries with ease
+- Allow builds to be configurable for common scenarios
+
+# Non-goals
+- Supporting all Gradle versions
+- Allow builds to be configurable for exotic scenarios

plugin/build.gradle.kts

@@ -30,7 +30,7 @@ gradlePlugin {
             id = "io.github.MatrixDev.android-rust"
             implementationClass = "dev.matrix.agp.rust.AndroidRustPlugin"
             displayName = "Plugin for building Rust with Cargo in Android projects"
-            description = "A plugin that helps build Rust JNI libraries with Cargo for use in Android projects."
+            description = "This plugin helps with building Rust JNI libraries with Cargo for use in Android projects."
         }
     }
 }