Skip to content

Commit 5106297

Browse files
committed
Update readme
1 parent 47ece0c commit 5106297

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,30 +13,47 @@ dependencies, and configurations used across Stream's Android projects.
1313

1414
## Available Plugins
1515

16+
- **`io.getstream.project`** - Root project configuration (apply to root `build.gradle.kts`)
1617
- **`io.getstream.android.library`** - For Android library modules
1718
- **`io.getstream.android.application`** - For Android application modules
1819
- **`io.getstream.java.library`** - For Java/Kotlin JVM library modules
1920

2021
## Usage
2122

22-
Add the plugin to your project's build file:
23+
### 1. Root Project Configuration
24+
25+
Apply the root plugin in your root `build.gradle.kts`:
2326

2427
```kotlin
2528
plugins {
26-
id("io.getstream.android.library") version "<version>"
27-
// or
28-
id("io.getstream.android.application") version "<version>"
29-
// or
30-
id("io.getstream.java.library") version "<version>"
29+
id("io.getstream.project") version "<version>"
30+
}
31+
32+
streamProject {
33+
// Repository name for GitHub URLs and license headers (default: project name)
34+
repositoryName.set("stream-chat-android")
35+
36+
// Choose formatter (default: false = ktlint)
37+
useKtfmt.set(false)
3138
}
3239
```
3340

34-
## Distribution
41+
### 2. Module Configuration
3542

36-
These plugins are published to:
43+
Apply the appropriate plugin to each module:
3744

38-
- [Maven Central](https://central.sonatype.com/)
39-
- [Gradle Plugin Portal](https://plugins.gradle.org/)
45+
```kotlin
46+
plugins {
47+
id("io.getstream.android.library")
48+
// or id("io.getstream.android.application")
49+
// or id("io.getstream.java.library")
50+
}
51+
52+
streamModule {
53+
// Disable Spotless for this module (default: true)
54+
spotlessEnabled.set(false)
55+
}
56+
```
4057

4158
## License
4259

0 commit comments

Comments
 (0)