[Common] Update README.md

.github/workflows/readme.yml

@@ -0,0 +1,38 @@
+name: Update README
+
+on:
+  push:
+    branches: [ "main" ]
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Get versions
+        id: versions
+        run: |
+          echo "GRADLE_VERSION=$(grep distributionUrl gradle/wrapper/gradle-wrapper.properties | sed -E 's/.*\/gradle-([0-9]+\.[0-9]+(\.[0-9]+)?)-bin.*/\1/;s/.*-([0-9]+\.[0-9]+\.[0-9]+)\.zip/\1/')" >> $GITHUB_ENV
+          echo "KOTLIN_VERSION=$(grep 'kotlin' gradle/libs.versions.toml | grep -oP 'version = "\K[^"]+')" >> $GITHUB_ENV
+          echo "PLUGIN_GRADLE_VERSION=$(grep 'plugin-gradle' gradle/libs.versions.toml | grep -oP 'version = "\K[^"]+')" >> $GITHUB_ENV
+        shell: bash
+
+      - name: Update README
+        run: |
+          cat README_TEMPLATE.md | envsubst > README.md
+
+      - name: Commit changes
+        run: |
+          git config user.name "${{ github.actor }}"
+          git config user.email "${{ github.actor }}@users.noreply.github.com"
+          git add README.md
+          git commit -m "Update README with latest versions [skip ci]"
+
+      - name: Push changes
+        uses: ad-m/[email protected]
+        with:
+          branch: main
+          github_token: ${{ secrets.GITHUB_TOKEN }}

README_TEMPLATE.md

@@ -0,0 +1,37 @@
+# Android-Template
+
+[![Android CI](https://github.com/ajou4095/template-android/actions/workflows/android.yml/badge.svg?branch=main)](https://github.com/ajou4095/template-android/actions/workflows/android.yml)
+
+## Description
+
+Android 개발 시 사용하는 template repository 입니다.
+복사 후 template 단어를 전체 검색해, 프로젝트 명으로 변경해주세요. (대소문자 주의해서 폴더까지 변경 부탁드립니다.)
+
+### Build
+
+- Gradle ${GRADLE_VERSION}
+- AGP ${PLUGIN_GRADLE_VERSION}
+- Kotlin ${KOTLIN_VERSION}
+- JDK 17
+- Kotlin DSL
+- Version Catalog
+
+### Library
+
+- KotlinX
+  - Coroutines
+  - Serialization
+  - DateTime
+- AndroidX
+  - Room
+  - Paging
+  - NavigationUI
+- Dagger Hilt
+- Ktor
+- Glide
+- Lottie
+- Debug & Log
+  - OkHttp3 Logging Interceptor (App Inspection)
+  - Leak Canary 2
+  - Timber
+  - Sentry