Skip to content

Commit 1120804

Browse files
committed
update: readme
1 parent 7b7e45f commit 1120804

File tree

1 file changed

+26
-9
lines changed

1 file changed

+26
-9
lines changed

README.md

Lines changed: 26 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@
2121
- Get your APK delivered to you on telegram with just a push of commit!
2222
- Automated Android APK Builds.
2323
- Unit Tests on Android Builds.
24-
- Supports Firebase based apps and signed builds with your custom key!
24+
- Supports **Firebase based apps** and **signed builds** with your custom key!
2525
- Forget wires, patches and building pull requests manually!
26+
- Slack support coming soon! (star and watch the project to stay updated !)
2627

2728
## Installation
2829

@@ -49,7 +50,7 @@ jobs:
4950
- uses: actions/checkout@v2
5051
- name: AppBrickie
5152
id: appBrickieBuild
52-
uses: DarthBenro008/app-brickie@v2.0
53+
uses: DarthBenro008/app-brickie@v3.0
5354
with:
5455
type: "native"
5556
chatid: "Your Unique ID Goes here"
@@ -76,7 +77,7 @@ jobs:
7677
- uses: actions/checkout@v2
7778
- name: AppBrickie
7879
id: appBrickieBuild
79-
uses: DarthBenro008/app-brickie@v2.0
80+
uses: DarthBenro008/app-brickie@v3.0
8081
with:
8182
type: "flutter"
8283
abi: "YOUR TARGET API" #Defaults to FAT APK
@@ -112,22 +113,38 @@ Specify the abi type you want to build, if you dont specify any by default it wi
112113

113114
<br>
114115

115-
#### **Optional Settings :**
116-
You can rename the app file name, by default its set to app-debug.apk, but to change that, add an input of packagename: "< YOUR APP NAME >"
116+
**Step 4:** Sit back and enjoy :D, get your build delivered to you on telegram automatically when a pull request or commit is created on master branch!
117+
118+
119+
### **Optional Settings :**
120+
**1. Custom Name -** You can rename the app file name, by default its set to app-debug.apk, but to change that, add an input of packagename: "< YOUR APP NAME >"
117121

118122
Eg:
119123
```yaml
120124
packagename: "myapp"
121125
```
122126

123-
**Step 4:** Sit back and enjoy :D, get your build delivered to you on telegram automatically when a pull request or commit is created on master branch!
127+
**2. Custom Key Sign -** You can sign the app build by AppBrickie with your own keystore! Check the instreuctions mentions [here](https://github.com/DarthBenro008/app-brickie/wiki/Firebase-and-Custom-Key-Signing#generating-secrets-to-enable-custom-key-signing-in-the-build) to learn how to generate the secrets for a successful key sign build.
128+
129+
Eg:
130+
```yaml
131+
keystore: ${{ secrets.KEYSTORE }}
132+
keystorePassword: ${{ secrets.KEYSTORE_PASS }}
133+
keyAlias: ${{ secrets.KEY_ALIAS }}
134+
keyPassword: ${{ secrets.KEYSTORE_PASS }}
135+
```
136+
137+
**3. Firebase -** If your app uses any of the firebase services, copy the contents of google-service.json file and paste it in a secret and pass it in the input param as shown below. [Check here for an example](https://github.com/DarthBenro008/app-brickie/wiki/Firebase-and-Custom-Key-Signing#firebase)
138+
139+
```yaml
140+
firebase: ${{ secrets.FIREBASE }}
141+
```
124142

125143
## Upcoming Features
126144

127-
- ~~Firebase apps build~~ (v3.0 supports Firebase Builds!)
128-
- ~~Custom Key Signing~~ (v3.0 supports custom key signing support!)
129145
- Slack integration
130-
- React Native Build Support
146+
147+
Note: v3.0 now supports firebase and custom build signing, refer changelog.
131148

132149
## Disclaimer
133150
You automatically agree to accept the default android-sdk license by using this github action. For more info refer [Android SDK T&C](https://developer.android.com/studio/terms)

0 commit comments

Comments
 (0)