From 05d329857ce9a4f8652407f646a8c187a68bb171 Mon Sep 17 00:00:00 2001
From: wukongdaily <143675923+wukongdaily@users.noreply.github.com>
Date: Sun, 3 Mar 2024 21:34:13 +0800
Subject: [PATCH] Update README.md

---
 README.md | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 86 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 7ea52d0..c19c70e 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,86 @@
-# tvhelper-docker
\ No newline at end of file
+# 盒子助手Docker版
+## 🤔 这是什么？
+
+该项目可以让你使用电脑、NAS等一切能运行docker的设备变成盒子的ADB安装助手。让你的盒子用起来更加得心应手。
+## 💡 特色功能
+
+- 💻 支持`一键修改安卓原生电视盒子/TV的NTP服务器地址`
+- 💻 支持`SSH连接 且容器内ADB服务均已准备就绪,无需额外安装`
+- 🔑 支持`安装装机必备app 尤其是文件管理器和三方市场、图标等`
+- 🌏 支持`一键批量安装主机上指定目录的全部apk`
+- 🐋 支持`Docker compose和 docker cli`一键部署
+- 📕 支持`为国行Sony电视安装时下流行的流媒体应用`
+- ❓ 兼容`ARM/x86_64 双平台设备,除了电脑系统外，主流NAS系统如群晖、威联通均已测试。另外CasaOS也测试了。还有就是ARM和X86_64平台的软路由iStoreOS/OpenWrt等`
+- ❓ 其他功能和特点会持续迭代
+
+
+## 🚀 快速上手
+
+### 1. 安装`Docker`和`Docker compose`
+
+- `Docker`安装教程：[https://docs.docker.com/engine/install/](https://docs.docker.com/engine/install/)
+- `Docker compose`安装教程：[https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
+- `个人普通电脑`安装教程：https://docs.docker.com/get-docker/
+
+### 2. 下载image
+
+```bash
+docker pull wukongdaily/box:latest
+```
+或者使用加速⏩ https://dockerproxy.com/
+```bash
+docker pull dockerproxy.com/wukongdaily/box:latest
+```
+### 3. 容器系统默认账号密码或环境变量
+
+容器内运行的就是alpine linux系统。ssh用户名和密码分别是：`root`和`password` 推荐ssh端口映射到主机端口为2299。<br>
+容器内的环境变量`PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/android-sdk/platform-tools`
+
+
+### 4. 运行
+
+```bash
+#Windows电脑使用-CMD写法,注意不是powershell 且注意💡续行符^后不能有空格。数据目录默认映射到 我的文档
+docker run -d ^
+--restart unless-stopped ^
+--name tvhelper ^
+-p 2299:22 ^
+-v "%USERPROFILE%\Documents\tvhelper_data:/tvhelper/shells/data" ^
+-e PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/android-sdk/platform-tools ^
+wukongdaily/box:latest
+
+```
+
+```bash
+#Linux 使用下列命令,数据目录默认映射到linux的/tmp/upload/下
+docker run -d \
+  --restart unless-stopped \
+  --name tvhelper \
+  -p 2299:22 \
+  -v "/tmp/upload/tvhelper_data:/tvhelper/shells/data" \
+  -e PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/android-sdk/platform-tools \
+  wukongdaily/box:latest
+```
+
+```bash
+#macOS苹果电脑写法,数据目录默认映射到mac电脑文稿目录下
+docker run -d \
+  --restart unless-stopped \
+  --name tvhelper \
+  -p 2299:22 \
+  -v "$HOME/Documents/tvhelper_data:/tvhelper/shells/data" \
+  -e PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/lib/android-sdk/platform-tools \
+  wukongdaily/box:latest
+```
+
+**🎉 大功告成**
+
+## 🗂️ 引用项目
+
+本项目的开发参照了以下项目，感谢这些开源项目的作者：
+### my-tv
+https://github.com/lizongying/my-tv
+### BBLL
+https://github.com/xiaye13579/BBLL
+### TVBox
+https://github.com/takagen99/Box