update readme

Author: BaseMax

README.md

@@ -1 +1,56 @@
-# AndroidAutoBuildAPK
+# Android Auto-Build APK
+
+This is an example of how to build an APK using GitHub Actions. Here, we created a simple Android application that displays a TODO. We then created a workflow that builds the APK and uploads it as a new release.
+
+## How to use
+
+```yml
+on:
+  push:
+    branches:
+      - main
+name: Build project after push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+          cache: gradle
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+      - name: Build with Gradle
+        run: ./gradlew build
+      - name: Build debug APK
+        run: bash ./gradlew assembleDebug --stacktrace
+
+      - name: Check files
+        run: ls -al app/build/outputs/apk/debug
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.TOKEN }}
+        with:
+          tag_name: ${{ github.run_number }}
+          release_name: ${{ github.event.repository.name }} v${{ github.run_number }}
+
+      - name: Upload Release APK
+        id: upload_release_asset
+        uses: actions/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: app/build/outputs/apk/debug/app-debug.apk
+          asset_name: ${{ github.event.repository.name }}.apk
+          asset_content_type: application/vnd.android.package-archive
+```
+
+Check out the [workflow](.github/workflows/build.yml) for more details.