From da3ee71dfd23a0f65634c474c2aabb0ad2f2daab Mon Sep 17 00:00:00 2001
From: yi_Xu <yi_Xu@yixuju.cn>
Date: Thu, 17 Jun 2021 22:10:03 +0800
Subject: [PATCH] Docs: update readme (#1044)

* docs: update README.md

- Fix the path and name of the release.
- Format the style with markdownlint.

* docs: fix apk name

* ci: add paths-ignore for workflow
---
 .github/workflows/build-unsigned.yaml | 25 ++++++++++++++++++++++++-
 README.md                             | 20 +++++++-------------
 2 files changed, 31 insertions(+), 14 deletions(-)

diff --git a/.github/workflows/build-unsigned.yaml b/.github/workflows/build-unsigned.yaml
index 5610252e..ed983fbd 100644
--- a/.github/workflows/build-unsigned.yaml
+++ b/.github/workflows/build-unsigned.yaml
@@ -1,5 +1,28 @@
 name: Build Unsigned
-on: [push, pull_request]
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '.github/**'
+      - '.idea/**'
+      - '.gitignore'
+      - '.gitmodules'
+      - '**.md'
+      - 'LICENSE'
+      - 'NOTICE'
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - '.github/**'
+      - '.idea/**'
+      - '.gitignore'
+      - '.gitmodules'
+      - '**.md'
+      - 'LICENSE'
+      - 'NOTICE'
 jobs:
   BuildUnsigned:
     runs-on: ubuntu-latest
diff --git a/README.md b/README.md
index 0b7a8fab..bb382373 100644
--- a/README.md
+++ b/README.md
@@ -8,26 +8,20 @@ A Graphical user interface of [clash](https://github.com/Dreamacro/clash) for An
 
 Fully feature of [clash](https://github.com/Dreamacro/clash) ~~(Exclude `external-controller`~~
 
-
-
 ### Requirement
 
-* Android 5.0+ (minimum)
-* Android 7.0+ (recommend)
-* `armeabi-v7a` , `arm64-v8a`, `x86` or `x86_64` Architecture
+- Android 5.0+ (minimum)
+- Android 7.0+ (recommend)
+- `armeabi-v7a` , `arm64-v8a`, `x86` or `x86_64` Architecture
 
 ### License
 
 See also [LICENSE](./LICENSE) and [NOTICE](./NOTICE)
 
-
-
-###  Privacy Policy
+### Privacy Policy
 
 See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
 
-
-
 ### Build
 
 1. Update submodules
@@ -38,7 +32,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
 
 2. Install **OpenJDK 11**, **Android SDK**, **CMake** and **Golang**
 
-3. Create `local.properties` in project root with 
+3. Create `local.properties` in project root with
 
    ```properties
    sdk.dir=/path/to/android-sdk
@@ -51,7 +45,7 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
    storePassword=<key store password>
    keyAlias=<key alias>
    keyPassword=<key password>
-   ``` 
+   ```
 
 5. Build
 
@@ -59,4 +53,4 @@ See also [PRIVACY_POLICY.md](./PRIVACY_POLICY.md)
    ./gradlew app:assembleFossRelease
    ```
 
-6. Pick `app-release-<arch>.apk` in `app/build/outputs/apks`
\ No newline at end of file
+6. Pick `app-foss-<arch>-release-signed.apk` in `app/build/outputs/apk/foss/release/`
-- 
GitLab