Skip to content

Commit 086ab14

Browse files
authored
chore: bump version & update README (#107)
1 parent 0c5c43b commit 086ab14

2 files changed

Lines changed: 64 additions & 33 deletions

File tree

gradle-plugins/react/README.md

Lines changed: 63 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,88 @@
1-
### React Native Brownfield Gradle Plugin
1+
# React Native Brownfield Gradle Plugin
2+
3+
![Maven Central](https://img.shields.io/maven-central/v/com.callstack.react/brownfield-gradle-plugin)
4+
25

36
This plugin helps you convert your react-native brownfield implementation into a fat Aar.
47

5-
#### Installation
8+
## Installation
69

7-
##### From Remote
10+
### From Remote
811

9-
- TBA
12+
To your top level `build.gradle` add
1013

11-
##### From Local
14+
```diff
15+
buildscript {
16+
repositories {
17+
google()
18+
mavenCentral()
19+
}
20+
dependencies {
21+
classpath("com.android.tools.build:gradle")
22+
classpath("com.facebook.react:react-native-gradle-plugin")
23+
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin")
24+
+ classpath("com.callstack.react:brownfield:0.3.0")
25+
}
26+
}
27+
```
28+
29+
To your brownfield project level `build.gradle.kts` add
30+
31+
```diff
32+
plugins {
33+
id("com.android.library")
34+
id("org.jetbrains.kotlin.android")
35+
+ id("com.callstack.react.brownfield")
36+
`maven-publish`
37+
id("com.facebook.react")
38+
}
39+
react {
40+
autolinkLibrariesWithApp()
41+
}
42+
43+
val appProject = project(":app")
44+
```
45+
46+
### From Local
1247

1348
- From the root of this repository, run `yarn brownfield:plugin:publish:local` and it will publish the plugin to your local maven
14-
- Then add the following patch to your react-native brownfield `build.gradle` files:
49+
50+
To your top level `build.gradle` add
1551

1652
```diff
17-
diff --git a/android/build.gradle b/android/build.gradle
18-
index 3dd1ac9..0db4ded 100644
19-
--- a/android/build.gradle
20-
+++ b/android/build.gradle
21-
@@ -16,6 +16,7 @@ buildscript {
22-
}
23-
+ mavenLocal()
24-
google()
25-
mavenCentral()
26-
}
27-
@@ -23,7 +24,7 @@ buildscript {
28-
classpath("com.android.tools.build:gradle")
29-
classpath("com.facebook.react:react-native-gradle-plugin")
30-
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin")
31-
+ classpath("com.callstack.react:brownfield:0.1.0")
32-
}
33-
}
53+
buildscript {
54+
repositories {
55+
+ mavenLocal()
56+
google()
57+
mavenCentral()
58+
}
59+
dependencies {
60+
classpath("com.android.tools.build:gradle")
61+
classpath("com.facebook.react:react-native-gradle-plugin")
62+
classpath("org.jetbrains.kotlin:kotlin-gradle-plugin")
63+
+ classpath("com.callstack.react:brownfield:0.3.0")
64+
}
65+
}
66+
```
67+
68+
To your brownfield project level `build.gradle.kts` add
3469

35-
diff --git a/android/rnbrownfield/build.gradle.kts b/android/rnbrownfield/build.gradle.kts
36-
index b915003..e387075 100644
37-
--- a/android/rnbrownfield/build.gradle.kts
38-
+++ b/android/rnbrownfield/build.gradle.kts
39-
@@ -1,7 +1,7 @@
70+
```diff
4071
plugins {
4172
id("com.android.library")
4273
id("org.jetbrains.kotlin.android")
4374
+ id("com.callstack.react.brownfield")
4475
`maven-publish`
4576
id("com.facebook.react")
4677
}
47-
@@ -10,8 +10,8 @@ react {
78+
react {
4879
autolinkLibrariesWithApp()
4980
}
5081

5182
val appProject = project(":app")
5283
```
5384

54-
#### API Usage
85+
## API Usage
5586

5687
- **About Dependencies**
5788

@@ -101,13 +132,13 @@ dependencies {
101132

102133
<hr/>
103134

104-
#### Tooling
135+
## Tooling
105136

106137
- We are using `ktlint` and `detekt` for formatting and linting
107138
- You can run `./gradlew :brownfield:lint` to auto-format and detect linting issues
108139

109140

110-
#### Architecture
141+
## Architecture
111142

112143
Below is a flow diagram of how the files are being used in this gradle plugin from an overview:
113144

gradle-plugins/react/brownfield/gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
PROJECT_ID=com.callstack.react.brownfield
22
ARTIFACT_ID=brownfield-gradle-plugin
3-
VERSION=0.2.0
3+
VERSION=0.3.0
44
GROUP=com.callstack.react
55
IMPLEMENTATION_CLASS=com.callstack.react.brownfield.plugin.RNBrownfieldPlugin
66

0 commit comments

Comments
 (0)