Merge pull request #22 from JohnsonRan/master

docs: bring up new README

.vuepress/config.js

@@ -4,42 +4,54 @@ module.exports = {
   head: [['link', { rel: 'icon', href: '/logo.png' }]],
   locales: {
     '/': {
-      lang: 'zh-CN',
+      lang: 'en-US',
     },
   },
   themeConfig: {
     nav: [
-      { text: '使用指南', link: '/guide/' },
+      { text: 'User Guide', link: '/guide/' },
       { text: 'FAQ', link: '/faq/' },
-      { text: '开发文档', link: '/dev/' },
-      { text: '参与我们', link: '/joinus/' },
+      { text: 'Developer Documentation', link: '/dev/' },
+      { text: 'Join Us', link: '/joinus/' },
       {
-        text: '客户端下载',
+        text: 'Downloads',
         items: [
           {
-            text: 'Android 端（酷安）',
+            text: 'Coolapk',
             link: 'https://www.coolapk.com/apk/net.xzos.upgradeall',
           },
           {
-            text: 'Android 端（GitHub）',
+            text: 'Github',
             link: '/~https://github.com/DUpdateSystem/UpgradeAll/releases',
           },
+          {
+            text: 'F-Droid',
+            link: 'https://f-droid.org/packages/net.xzos.upgradeall',
+          },
+          {
+            text: 'Telegram CI',
+            link: 'https://t.me/upallci',
+          },
         ],
       },
       { text: 'GitHub', link: '/~https://github.com/DUpdateSystem' },
     ],
     sidebarDepth: 2,
     sidebar: [
       {
-        title: '使用指南',
+        title: 'User Guide',
         path: '/guide/',
+        children: [
+          '/guide/',
+          '/guide/magisk',
+        ],
       },
       {
         title: 'FAQ',
         path: '/faq/',
       },
       {
-        title: '开发者文档',
+        title: 'Developer Documentation',
         path: '/dev/',
         children: [
           '/dev/',
@@ -52,15 +64,15 @@ module.exports = {
         ],
       },
       {
-        title: '参与我们',
+        title: 'Join Us',
         path: '/joinus/',
         children: [
           '/joinus/',
           '/joinus/docs',
         ],
       },
     ],
-    lastUpdated: '最后更新时间',
+    lastUpdated: 'Latest Update',
   },
   plugins: [['@vuepress/active-header-links'], ['@vuepress/back-to-top']],
 };

faq/README.md

@@ -1,23 +1,19 @@
-## 云端仓库网络错误
+## Cloud-based repository network error
 
-检查云端仓库地址是否正确。目前我们支持三个网址，请自行选择。推荐使用 jsdelivr CDN 源。
+Check if the cloud repository address is correct. Currently we support three URLs, please choose your own. We recommend using the `jsdelivr CDN` source.
 
-1. [Coding 源（GitHub 镜像源）](https://dupdatesystem.coding.net/p/UpgradeAll-rules/d/UpgradeAll-rules/git/raw/master/rules/rules.json)
-2. [Jsdelivr CDN 源（GitHub 文件加速）](https://cdn.jsdelivr.net/gh/DUpdateSystem/UpgradeAll-rules@master/rules/rules.json)
-3. [GitHub 源](https://raw.githubusercontent.com/DUpdateSystem/UpgradeAll-rules/master/rules/rules.json)
+1. [Coding (For China Mainland)](https://dupdatesystem.coding.net/p/UpgradeAll-rules/d/UpgradeAll-rules/git/raw/master/rules/rules.json)
+2. [Jsdelivr CDN (Recommanded for areas which cant access Github well)](https://cdn.jsdelivr.net/gh/DUpdateSystem/UpgradeAll-rules@master/rules/rules.json)
+3. [GitHub](https://raw.githubusercontent.com/DUpdateSystem/UpgradeAll-rules/master/rules/rules.json)
 
-## 快速进入项目或应用主页
+## Quick access to project or app home page
 
-点击更新数据下面的网址即可跳转。
+Click on the URL below the updated data to jump to it.
 
-## 更换侧滑顶部的背景图片
+## View check updates progress
 
-打开侧滑，点击上方蓝色方块，选择一张你想设为背景的图片，就可以了。
+Open the notification bar and you can see the progress. If not, you may have disabled the notification permission, just turn it on in the settings.
 
-## 查看下载进度
+## View download progress
 
-打开通知栏，即可看见进度。如没有，可能是禁用了通知权限，在设置中打开即可。
-
-## 修改分组设置
-
-长按分组即可设置。可以添加分组、设置分组图标和标题。
+Open the notification bar and you can see the progress. If not, you may have disabled the notification permission, just turn it on in the settings.

guide/README.md

@@ -1,55 +1,50 @@
-# 介绍
+# Introduction
 
-用一个软件检查所有应用的更新。
+Check for Android apps, Magisk modules and more!
 
-目前 UpgradeAll 由服务端（建设中）与客户端组成。服务端定时抓取并缓存。客户端通过 api 获取更新数据并展示。
+UpgradeAll currently consists of a server-side and a client-side. The server side regularly crawls and caches. The client gets the updated data via api and displays it.
 
-## Android 端使用教程
+## How to add apps
 
-### 添加软件源
+### Add Apps
+<img src="../source/screenshot/1.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/2.png" alt="ScreenShot" height="520">
 
-1. 点击侧栏的云端仓库
-2. 切换到软件源选项卡
-3. 长按想要下载的软件源点击下载
+1. Open `App Hub` page from home page
+2. Open `App Hub` you want to use
+3. Open `Application Market` mode to detect updates for all installed apps
 
-### 通过云端仓库添加软件
+### Add apps via cloud-based repository
+<img src="../source/screenshot/3.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/4.png" alt="ScreenShot" height="520">
 
-1. 点击侧栏的云端仓库
-2. 切换到软件选项卡
-3. 长按下载想要的软件（酷安和 f-droid 已支持应用市场模式，无需下载。）
+1. Open `Discover` page from home page
+2. Find the apps you want and click on download (Coolapk and F-Droid already support app market mode, no need to download.)
 
-### 手动添加软件
+### Add apps manually
 
-::: warning 注意
-手动添加软件请确保已经添加对应的软件源！
+::: warning Attention
+Please make sure that the corresponding `App Hub` has been added manually!
 :::
 
-1. 点击主界面加号
-2. 点击添加单个跟踪项
+<img src="../source/screenshot/5.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/6.png" alt="ScreenShot" height="520">
 
-#### 填写基础信息
+1. Click `Apps` page top right corner `Add App` 
 
-1. 点击软件源然后选择想要的软件源
-2. 填写名称（选填）
-3. 填写网址
-   * 软件官网：官网网址
-   * 应用商店：应用详情页
-   * GitHub 等开源社区：项目主页
+Take `UpgradeAll` as example:  
+`/~https://github.com/DUpdateSystem/UpgradeAll`
+1. `Name` Fill in the name of the tracking app you want to set (feel free to do so)
+2. Add attributes first(we need three attributes), then select `android_app_package` on key and fill in the value with the package name of `UpgradeAll`: `net.xzos.upgradeall`
+3. Select `owner` and fill in the value with the repo owner `DUpdateSystem`
+4. After that, Select `repo` and fill in the value with the project name `UpgradeAll`.
 
-#### 填写版本控制设置
 
-1. 点击 App 版本选择对应的选项
-2. 填写跟踪目标（点击问号查看如何搜索）
-3. 点击右下角确认添加
+### Auto-add apps
 
-### 添加应用市场
+<img src="../source/screenshot/7.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/8.png" alt="ScreenShot" height="520">
 
-1. 点击主界面加号
-2. 点击添加应用市场
-3. 点击软件源选择应用市场（目前仅支持酷安和 F-droid）
-4. 点击网址输入框（网址会自动添加）
-5. 点击右下角确认添加
-
-::: danger 警告
-不要更改自动添加的网址！
-:::
+1. `Edit App` page, top right corner, click `Parse attributes from URL`.
+2. Fill in the full URL of the app, eg. `/~https://github.com/DUpdateSystem/UpgradeAll`.
+3. Fill in the name of the tracking item at the top.

guide/magisk.md

@@ -0,0 +1,50 @@
+# Introduction
+
+Check for Android apps, Magisk modules and more!
+
+UpgradeAll currently consists of a server-side and a client-side. The server side regularly crawls and caches. The client gets the updated data via api and displays it.
+
+## How to add Magisk Modules
+
+### Add Magisk Modules
+<img src="../source/screenshot/1.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/2.png" alt="ScreenShot" height="520">
+
+1. Open `App Hub` page from home page
+2. Open `App Hub` you want to use()
+3. Open `Application Market` mode to detect updates for all installed apps
+
+### Add apps via cloud-based repository
+<img src="../source/screenshot/3.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/4.png" alt="ScreenShot" height="520">
+
+1. Open `Discover` page from home page
+2. Find the apps you want and click on download (Coolapk and F-Droid already support app market mode, no need to download.)
+
+### Add apps manually
+
+::: warning Attention
+Please make sure that the corresponding `App Hub` has been added manually!
+:::
+
+<img src="../source/screenshot/5.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/6.png" alt="ScreenShot" height="520">
+
+1. Click `Apps` page top right corner `Add App` 
+
+Take `UpgradeAll` as example:  
+`/~https://github.com/DUpdateSystem/UpgradeAll`
+1. `Name` Fill in the name of the tracking app you want to set (feel free to do so)
+2. Add attributes first(we need three attributes), then select `android_app_package` on key and fill in the value with the package name of `UpgradeAll`: `net.xzos.upgradeall`
+3. Select `owner` and fill in the value with the repo owner `DUpdateSystem`
+4. After that, Select `repo` and fill in the value with the project name `UpgradeAll`.
+
+
+### Auto-add apps
+
+<img src="../source/screenshot/7.png" alt="ScreenShot" height="520">
+<img src="../source/screenshot/8.png" alt="ScreenShot" height="520">
+
+1. `Edit App` page, top right corner, click `Parse attributes from URL`.
+2. Fill in the full URL of the app, eg. `/~https://github.com/DUpdateSystem/UpgradeAll`.
+3. Fill in the name of the tracking item at the top.

joinus/README.md

@@ -1,14 +1,11 @@
 # 参与讨论
 
-欢迎加入群组与我们讨论交流，如果有任何的想法或需求都可以在群组或者在 issue 中告诉我们。
+If you have any ideas or needs, please let us know in the group or raise an issue
 
-::: tip 提示
-建议使用 issues 来告诉我们，这样便于管理及查看。提 issues 前查看 [issue 准则](../dev/contributing#issue-准则)。
-:::
-
-1. [Telegram 群组](https://t.me/DUpdateSystem)（推荐）
-2. [QQ 群](https://jq.qq.com/?_wv=1027&k=5SUNszN)（群号：`916736220`）
+1. [Telegram Group](https://t.me/DUpdateSystem)（Recommanded）
+2. [QQ Group](https://jq.qq.com/?_wv=1027&k=5SUNszN)（Group Number：`916736220`）
 3. issue：
-   1. [服务端相关](/~https://github.com/DUpdateSystem/Server/issues)
-   2. [Android 客户端相关](/~https://github.com/DUpdateSystem/UpgradeAll/issues)
-   3. [文档相关（建议、错误等...）](/~https://github.com/DUpdateSystem/docs/issues)
+   1. [Server related](/~https://github.com/DUpdateSystem/Server/issues)
+   2. [Android Client related](/~https://github.com/DUpdateSystem/UpgradeAll/issues)
+   3. [App Hub related](/~https://github.com/DUpdateSystem/UpgradeAll-rules/issues/new/choose)
+   3. [Documentation related (suggestions, errors, etc.)](/~https://github.com/DUpdateSystem/docs/issues)

package.json

@@ -4,8 +4,8 @@
     "build": "vuepress build ."
   },
   "devDependencies": {
-    "@vuepress/plugin-active-header-links": "^1.5.2",
-    "@vuepress/plugin-nprogress": "^1.5.2",
-    "vuepress": "^1.5.2"
+    "@vuepress/plugin-active-header-links": "^1.9.7",
+    "@vuepress/plugin-nprogress": "^1.9.7",
+    "vuepress": "^1.9.7"
   }
 }