Skip to content

Commit b75cd18

Browse files
committed
2021-05-14 v. 1.0.0: added documentation
1 parent 51afb87 commit b75cd18

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

README.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# flutter-rb-gradle-plugin
2+
3+
## About
4+
5+
Gradle plugin for [flutter_rb](https://github.com/fartem/flutter_rb).
6+
7+
## How to use
8+
9+
This plugin needs for [flutter_rb](https://github.com/fartem/flutter_rb). Just implement it to your library and use `flutter_rb`.
10+
11+
### Implementation
12+
13+
Add this config to `build.gradle` at the root of the project:
14+
15+
```groovy
16+
buildscript {
17+
repositories {
18+
// Other repositories
19+
maven { url "https://jitpack.io" }
20+
}
21+
22+
dependencies {
23+
// Other dependencies
24+
classpath 'com.github.fartem:flutter-rb-gradle-plugin:1.0.0'
25+
}
26+
}
27+
28+
apply plugin: 'com.smlnskgmail.jaman.flutterrb'
29+
30+
dependencies {
31+
// Other dependencies
32+
implementation 'com.github.fartem:flutter-rb-gradle-plugin:1.0.0'
33+
}
34+
```
35+
36+
### Test run
37+
38+
You can run plugin as Gradle task:
39+
40+
```shell
41+
./gradlew -q prepareInfo
42+
```
43+
44+
## How to contribute
45+
46+
Read [Commit Convention](https://github.com/fartem/repository-rules/blob/master/commit-convention/COMMIT_CONVENTION.md). Make sure your build is green before you contribute your pull request. Then:
47+
48+
```shell
49+
./gradlew clean build
50+
```
51+
52+
## Contributors
53+
54+
- [@fartem](https://github.com/fartem) as Artem Fomchenkov

0 commit comments

Comments
 (0)