Skip to content

Commit 9d00ef4

Browse files
committed
Add readme
1 parent 4b765a2 commit 9d00ef4

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

README.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Stream Build Conventions for Android
2+
3+
Gradle convention plugins for Stream Android projects. These plugins provide standardized build
4+
configurations to ensure consistency across Stream's Android libraries and applications.
5+
6+
> **Note:** These plugins are designed specifically for Stream's projects and workflows. They aren't
7+
> intended for general-purpose use and may include Stream-specific configurations and conventions.
8+
9+
## Overview
10+
11+
This repository contains reusable Gradle convention plugins that encapsulate common build logic,
12+
dependencies, and configurations used across Stream's Android projects.
13+
14+
## Available Plugins
15+
16+
- **`io.getstream.android.library`** - For Android library modules
17+
- **`io.getstream.android.application`** - For Android application modules
18+
- **`io.getstream.java.library`** - For Java/Kotlin JVM library modules
19+
20+
## Usage
21+
22+
Add the plugin to your project's build file:
23+
24+
```kotlin
25+
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>"
31+
}
32+
```
33+
34+
## Distribution
35+
36+
These plugins are published to:
37+
38+
- [Maven Central](https://central.sonatype.com/)
39+
- [Gradle Plugin Portal](https://plugins.gradle.org/)
40+
41+
## License
42+
43+
See [LICENSE](LICENSE) file for details.

0 commit comments

Comments
 (0)