Skip to content

Commit d0f1f6f

Browse files
committed
update: readme
1 parent d461538 commit d0f1f6f

2 files changed

Lines changed: 26 additions & 10 deletions

File tree

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@
44
<a href="https://github.com/DarthBenro008/app-brickie/blob/master/LICENSE" target="_blank">
55
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-green.svg" />
66
</a>
7+
<a href="https://github.com/DarthBenro008/app-brickie/releases" target="_blank">
8+
<img src="https://img.shields.io/github/v/release/DarthBenro008/app-brickie?color=orange&include_prereleases" />
9+
</a>
10+
<a href="https://github.com/DarthBenro008/app-brickie/releases" target="_blank">
11+
<img alt="Github: Action" src="https://img.shields.io/badge/Github-Action-lightgrey" />
12+
</a>
713
</p>
814

915
**AppBrickie** - _Your Friendly App Builder Action._
@@ -19,7 +25,7 @@
1925

2026
## Installation
2127

22-
Step 1: Add the following yaml file as build.yml in .github/workflows folder of your app repository
28+
**Step 1:** Add the following yaml file as build.yml in .github/workflows folder of your app repository
2329

2430
```yaml
2531
name: CI
@@ -33,30 +39,38 @@ on:
3339
jobs:
3440
build:
3541
runs-on: ubuntu-latest
36-
name: App Builder
42+
name: App Brickie
3743
steps:
3844
- uses: actions/checkout@v2
3945
- name: AppBrickie
4046
id: appBrickieBuild
41-
uses: DarthBenro008/app-brickie@v1.0-alpha03
47+
uses: DarthBenro008/app-brickie@v1.0
4248
with:
4349
chatid: "Your Unique ID Goes here"
50+
packagename: "Your App Name Goes Here"
4451
- name: Get Automated Result
4552
run: echo "${{ steps.appBrickieBuild.outputs.result }}"
4653
```
4754
48-
Step 2 : Go To [@AppBrickieBot](https://t.me/appbrickiebot) on Telegram to generate your unique id.
55+
**Step 2 :** Go To [@AppBrickieBot](https://t.me/appbrickiebot) on Telegram to generate your unique id.
4956
50-
Step 3: Replace your UniqueID from the bot in the YAML File above besides chatid **in quotes**
57+
**Step 3:** Replace your UniqueID from the bot in the YAML File above besides chatid **in quotes**
5158
for eg:
5259
5360
```yaml
5461
chatid: "qwerty12345"
5562
```
5663
57-
Step 4: Add name constraints of your app
64+
#### **Optional Settings :**
65+
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 >"
66+
67+
Eg:
68+
```yaml
69+
chatid: "qwerty12345"
70+
packagename: "myapp"
71+
```
5872
59-
Step 5: Sit back and enjoy :D get your build delivered to telegram automatically on pull requests and commits on master branch!
73+
**Step 4:** Sit back and enjoy :D get your build delivered to telegram automatically on pull requests and commits on master branch!
6074
6175
## Upcoming Features
6276
@@ -69,11 +83,11 @@ You automatically agree to accept the default android-sdk license by using this
6983
7084
7185
## Author
72-
🧔 Hemanth Krishna [@DarthBenro008](http://github.com/DarthBenro008)
86+
👨‍💻 Hemanth Krishna [@DarthBenro008](http://github.com/DarthBenro008)
7387
7488
## Show your support
7589
76-
Give a ⭐ if this project helped you out!
90+
Give a ⭐ if this project made your life easy !
7791
7892
Spread the word!
7993
@@ -82,6 +96,7 @@ Spread the word!
8296
- Feel Free to Open a PR/Issue for any feature or bug
8397
- Make sure you follow the community guidelines !
8498
- Feel free to open an issue to ask a question/discuss anything about AppBrickie
99+
- Have a feature request? Open an Issue!
85100
86101
## License
87102

entrypoint.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ if [ -z "$INPUT_PACKAGENAME" ]
2727
then
2828
sendpackage
2929
else
30-
packageName="$INPUT_PACKAGENAME.apk"
30+
rectifiedName=${INPUT_PACKAGENAME// /_}
31+
packageName="$rectifiedName.apk"
3132
renamePackage
3233
sendpackage
3334
fi

0 commit comments

Comments
 (0)