doc: update README

This commit is contained in:
Xinrea
2025-04-30 03:36:55 +08:00
parent bdf017024a
commit 16906a46cd

View File

@@ -2,7 +2,9 @@
![icon](docs/header.png)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/xinrea/bili-shadowreplay/main.yml)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/xinrea/bili-shadowreplay/main.yml?label=Application%20Build)
![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/Xinrea/bili-shadowreplay/package.yml?label=Docker%20Build)
![GitHub Release](https://img.shields.io/github/v/release/xinrea/bili-shadowreplay)
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/xinrea/bili-shadowreplay/total)
@@ -12,6 +14,23 @@ BiliBili ShadowReplay 是一个缓存直播并进行实时编辑投稿的工具
![rooms](docs/summary.png)
## Headless
BiliBili ShadowReplay 支持无界面模式,提供 Web 控制界面,可以用于在服务器等无图形界面环境下部署使用。
使用方法:
```bash
sudo docker run -it -d\
-p 3000:3000 \
-v $DATA_DIR:/app/data \
-v $CACHE_DIR:/app/cache \
-v $OUTPUT_DIR:/app/output \
-v $CONFIG_FILE:/app/config.toml \
--name bili-shadowreplay \
ghcr.io/xinrea/bili-shadowreplay:latest
```
## 参与开发
[Contributing](.github/CONTRIBUTING.md)