OSDN Git Service

README: add tips for LuCI app
authorTianling Shen <cnsztl@immortalwrt.org>
Tue, 6 Sep 2022 14:06:43 +0000 (22:06 +0800)
committerTianling Shen <cnsztl@immortalwrt.org>
Tue, 6 Sep 2022 14:06:43 +0000 (22:06 +0800)
Signed-off-by: Tianling Shen <cnsztl@immortalwrt.org>
README.md
README.zh-cn.md

index a5b4f1c..41160c1 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,20 +42,32 @@ opkg feed of v2rayA for OpenWrt users.
 
 ## How to use
 
-1. Setup v2rayA
+- Method 1 - Configure via LuCI interface (for __OpenWrt 21.02 and higher__ version only)
 
-   ```sh
-   # For advanced usage, please see /etc/config/v2raya
-   uci set v2raya.config.enabled='1'
-   uci commit v2raya
-   ```
+   1. Install LuCI app
 
-2. Start v2rayA
+      ```sh
+      opkg install luci-app-v2raya
+      ```
 
-   ```sh
-   /etc/init.d/v2raya start
-   ```
+   2. Visit `http://<your_router_ip>/cgi-bin/luci/admin/services/v2raya` and complete setup.
+
+- Method 2 - Configure via cli
+
+   1. Setup v2rayA
+
+      ```sh
+      # For advanced usage, please see /etc/config/v2raya
+      uci set v2raya.config.enabled='1'
+      uci commit v2raya
+      ```
+
+   2. Start v2rayA
+
+      ```sh
+      /etc/init.d/v2raya start
+      ```
 
-3. Visit v2rayA webUI and enjoy
+   3. Visit v2rayA webUI and enjoy
 
-   http://openwrt.lan:2017
+      `http://<your_router_ip>:2017`
index c2d6d9c..8353d3e 100644 (file)
@@ -1,6 +1,6 @@
 # v2raya-openwrt
 
-适用于 OpenWrt 用户的 opkg 软件源。
+适用于 OpenWrt 用户的 v2rayA opkg 软件源。
 
 [English](README.md)
 
@@ -8,7 +8,7 @@
 
 1. 导入 v2rayA 签名文件
 
-   > 请确认软件包 `wget-ssl` 已经安装在您的设备上
+   > 请确认软件包 `wget-ssl` 已经正确地安装在您的设备上
 
    ```sh
    wget https://osdn.net/projects/v2raya/storage/openwrt/v2raya.pub -O /etc/opkg/keys/94cc2a834fb0aa03
 
 ## 使用方法
 
-1. 配置 v2rayA
+- 方法一:通过 LuCI 界面配置(仅适用于 __OpenWrt 21.02 或更高版本__)
 
-   ```sh
-   # 详细配置请参见 /etc/config/v2raya
-   uci set v2raya.config.enabled='1'
-   uci commit v2raya
-   ```
+   1. 安装 LuCI app
+      ```sh
+      opkg install luci-app-v2raya
+      ```
 
-2. 启动 v2rayA
+   2. 访问 `http://<your_router_ip>/cgi-bin/luci/admin/services/v2raya` 并完成配置。
 
-   ```sh
-   /etc/init.d/v2raya start
-   ```
+- 方法二:通过命令行配置
+
+   1. 配置 v2rayA
+
+      ```sh
+      # 详细配置请参见 /etc/config/v2raya
+      uci set v2raya.config.enabled='1'
+      uci commit v2raya
+      ```
+
+   2. 启动 v2rayA
+
+      ```sh
+      /etc/init.d/v2raya start
+      ```
 
-3. 访问 v2rayA webUI 面板并完成设置
+   3. 访问 v2rayA webUI 面板并完成设置
 
-   http://openwrt.lan:2017
+      `http://<your_router_ip>:2017`