Skip to content

Commit

Permalink
update: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DarthBenro008 committed Aug 30, 2020
1 parent d461538 commit d0f1f6f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 10 deletions.
33 changes: 24 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@
<a href="https://github.com/DarthBenro008/app-brickie/blob/master/LICENSE" target="_blank">
<img alt="License: MIT" src="https://img.shields.io/badge/License-MIT-green.svg" />
</a>
<a href="https://github.com/DarthBenro008/app-brickie/releases" target="_blank">
<img src="https://img.shields.io/github/v/release/DarthBenro008/app-brickie?color=orange&include_prereleases" />
</a>
<a href="https://github.com/DarthBenro008/app-brickie/releases" target="_blank">
<img alt="Github: Action" src="https://img.shields.io/badge/Github-Action-lightgrey" />
</a>
</p>

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

## Installation

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

```yaml
name: CI
Expand All @@ -33,30 +39,38 @@ on:
jobs:
build:
runs-on: ubuntu-latest
name: App Builder
name: App Brickie
steps:
- uses: actions/checkout@v2
- name: AppBrickie
id: appBrickieBuild
uses: DarthBenro008/[email protected]-alpha03
uses: DarthBenro008/[email protected]
with:
chatid: "Your Unique ID Goes here"
packagename: "Your App Name Goes Here"
- name: Get Automated Result
run: echo "${{ steps.appBrickieBuild.outputs.result }}"
```
Step 2 : Go To [@AppBrickieBot](https://t.me/appbrickiebot) on Telegram to generate your unique id.
**Step 2 :** Go To [@AppBrickieBot](https://t.me/appbrickiebot) on Telegram to generate your unique id.
Step 3: Replace your UniqueID from the bot in the YAML File above besides chatid **in quotes**
**Step 3:** Replace your UniqueID from the bot in the YAML File above besides chatid **in quotes**
for eg:
```yaml
chatid: "qwerty12345"
```
Step 4: Add name constraints of your app
#### **Optional Settings :**
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 >"
Eg:
```yaml
chatid: "qwerty12345"
packagename: "myapp"
```
Step 5: Sit back and enjoy :D get your build delivered to telegram automatically on pull requests and commits on master branch!
**Step 4:** Sit back and enjoy :D get your build delivered to telegram automatically on pull requests and commits on master branch!
## Upcoming Features
Expand All @@ -69,11 +83,11 @@ You automatically agree to accept the default android-sdk license by using this
## Author
🧔 Hemanth Krishna [@DarthBenro008](https://github.com/DarthBenro008)
👨‍💻 Hemanth Krishna [@DarthBenro008](https://github.com/DarthBenro008)
## Show your support
Give a ⭐ if this project helped you out!
Give a ⭐ if this project made your life easy !
Spread the word!
Expand All @@ -82,6 +96,7 @@ Spread the word!
- Feel Free to Open a PR/Issue for any feature or bug
- Make sure you follow the community guidelines !
- Feel free to open an issue to ask a question/discuss anything about AppBrickie
- Have a feature request? Open an Issue!
## License
Expand Down
3 changes: 2 additions & 1 deletion entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ if [ -z "$INPUT_PACKAGENAME" ]
then
sendpackage
else
packageName="$INPUT_PACKAGENAME.apk"
rectifiedName=${INPUT_PACKAGENAME// /_}
packageName="$rectifiedName.apk"
renamePackage
sendpackage
fi

0 comments on commit d0f1f6f

Please sign in to comment.