02-docker 07-feed better

Readme.md

@@ -6,8 +6,12 @@
 
 **软件使用可能需要一定的网络基础。如果遇到无法解决的问题，建议直接放弃 ^ _ ^ 。**
 
+TG 交流群：https://t.me/elecV2G (主要为方便群友使用交流，群主24小时不在线，也不负责解答任何问题。)
+
+如果遇到问题还是建议开一个 issue，并注明使用平台，版本，以及附上相关的错误日志。
+
 ### 说明
 
-- 文档目录：docs
-- 例程目录：examples
-- 初次使用建议先把 docs 浏览一遍，涉及内容较多，大部分可以直接跳过。在使用中碰到问题时再回过头来查看
+- 文档目录：[docs](https://github.com/elecV2/elecV2P-dei/tree/master/docs)
+- 例程目录：[examples](https://github.com/elecV2/elecV2P-dei/tree/master/examples)
+- 初次使用建议先把 docs 内容浏览一遍，涉及内容较多，大部分可以直接跳过，在使用中碰到问题时再回过头来查看

docs/02-Docker.md

@@ -1,16 +1,16 @@
 ```
-最近更新： 2020-12-21
-适用版本： 2.9.3
+最近更新： 2021-01-26
+适用版本： 3.1.0
 ```
 
 ## 简介
 
 Docker 地址：https://hub.docker.com/r/elecv2/elecv2p
 
-基础镜像：elecv2/elecv2p
-ARM 镜像：（适用于 N1/OPENWRT/树莓派等 ARM 架构的系统）
-- elecv2/elecv2p:arm64
-- elecv2/elecv2p:arm32
+- 基础镜像：elecv2/elecv2p
+- ARM镜像：（适用于 N1/OPENWRT/树莓派等 ARM 架构的系统）
+  - elecv2/elecv2p:arm64
+  - elecv2/elecv2p:arm32
 
 ## docker 及 docker-compose 的安装
 
@@ -25,21 +25,26 @@ curl -L "https://github.com/docker/compose/releases/download/1.27.4/docker-compo
 
 ## 相关命令
 
-*以下命令仅作为参考，具体映射端口和卷根据实际情况进行调整*
+*以下命令仅供参考，具体映射端口和卷根据实际情况进行调整*
 ```sh
 # 基础启动命令
 docker run --restart=always -d --name elecv2p -p 80:80 -p 8001:8001 -p 8002:8002 elecv2/elecv2p
 
 # 宿主机保留 JS 文件/规则/任务/复写等列表/Store 文件等
-docker run --restart=always -d --name elecv2p -v /elecv2p:/usr/local/app/script -p 8100:80 -p 8101:8001 -p 8102:8002 elecv2/elecv2p
+docker run --restart=always -d --name elecv2p -v /elecv2p/script:/usr/local/app/script -p 8100:80 -p 8101:8001 -p 8102:8002 elecv2/elecv2p
 
-# 使用 ARM 镜像，时区更改以及持久化存储
-docker run --restart=always -d --name elecv2p -e TZ=Asia/Shanghai -p 8100:80 -p 8101:8001 -p 8102:8002 -v /elecv2p/JSFile:/usr/local/app/script/JSFile -v /elecv2p/Store:/usr/local/app/script/Store elecv2/elecv2p:arm32
+# 使用 ARM 镜像，并调整时区以及持久化存储
+docker run --restart=always -d --name elecv2p \
+  -e TZ=Asia/Shanghai \
+  -p 8100:80 -p 8101:8001 -p 8102:8002 \
+  -v /elecv2p/JSFile:/usr/local/app/script/JSFile \
+  -v /elecv2p/Store:/usr/local/app/script/Store \
+  elecv2/elecv2p:arm32
 
 # 查看 docker 运行状态
 docker ps
 
-# 进入镜像内部
+# 进入容器内部
 docker exec -it elecv2p /bin/sh
 
 # Docker 的启动暂停
@@ -68,9 +73,11 @@ docker pull elecv2/elecv2p
 mkdir /elecv2p && cd /elecv2p
 curl -sL https://git.io/JLw7s > docker-compose.yaml
 docker-compose up -d
-```
 
-*注意：默认的 docker-compose.yaml 文件已将 80/8001/8002 端口分别映射成了 8100/8101/8102，以防出现端口占用的情况。在访问时注意一下。如需调整为其他端口，可以自行修改下面的内容进行保存。*
+# 注意：默认的 docker-compose.yaml 文件使用的是基础镜像，如果是 ARM 平台请使用下面的文件手动进行修改。
+# 另外，默认把 80/8001/8002 端口分别映射成了 8100/8101/8102，以防出现端口占用的情况，访问时注意。
+# 如果需要调整为其他端口，可以自行修改下面的内容然后手动保存。
+```
 
 或者将以下内容手动保存为 docker-compose.yaml 文件。
 ``` yaml
@@ -97,14 +104,15 @@ services:
 
 然后在 docker-compose.yaml 同目录执行命令 **docker-compose up -d** 启动程序。
 
-*部分用户反映，在有些设备上需要调整 version 的版本才能启动成功。如果启动出现问题，可以尝试把 docker-compose.yaml 文件开头的 version: '3.7' 更改为 version: '3.3'.*
+*部分用户反映，在某些设备上需要调整 version 的版本才能启动。如果启动出现问题，可以尝试把 docker-compose.yaml 文件开头的 version: '3.7' 更改为 version: '3.3'。*
 
 ### 其他指令
 
 ``` sh
-# 更新容器
+# 更新升级
 docker-compose pull elecv2p && docker-compose up -d
 
+# 其他参考指令
 docker restart elecv2p_elecv2p_1
 docker exec -it elecv2p_elecv2p_1 /bin/sh
 docker logs elecv2p_elecv2p_1 -f

docs/07-feed&notify.md

@@ -1,6 +1,6 @@
 ```
-最近更新： 2021-01-24
-适用版本： 3.0.9
+最近更新： 2021-01-26
+适用版本： 3.1.0
 ```
 
 ## 通知方式
@@ -98,7 +98,7 @@ POST 方式，内容如下：
 }
 ```
 
-*数据最终提交格式，会自动进行判断。如果是 json 格式，会自动以 application/json 的方式提交。*
+*数据最终提交格式，会自动进行判断。如果是 JSON 格式，会自动以 application/json 的方式提交。*
 
 ## 默认通知内容
 
@@ -116,10 +116,12 @@ POST 方式，内容如下：
 ``` JS example
 $feed.push('elecV2P notification', '这是一条来自 elecV2P 的通知', 'https://github.com/elecV2/elecV2P')
 
-$feed.ifttt('title', 'description', 'https://github.com/elecV2/elecV2P-dei')   // 发送一条 ifttt 通知
-// 先设置好 ifttt webhook key
-
-$feed.bark('Bark notification', 'a bark notification', 'https://t.me/elecV2')  // 发送一条 bark 通知
+// 发送一条 IFTTT 通知。（先设置好 ifttt webhook key）
+$feed.ifttt('title', 'description', 'https://github.com/elecV2/elecV2P-dei')   
+// 发送一条 BARK 通知
+$feed.bark('Bark notification', 'a bark notification', 'https://t.me/elecV2')
+// 发送一条自定义通知
+$feed.cust('elecV2P customize notification', `一条自定义通知。\na customize notification` , 'https://t.me/elecV2')
 ```
 
 ### 其他说明