Merge pull request 'docs: update link to artifact + ci badge' (#17) from readme/ci-link-and-badge into master

Reviewed-on: https://git.unlock-music.dev/um/web/pulls/17
2024-12-29 21:45:02 +08:00 · 2022-11-27 00:56:21 +00:00 · 2022-11-27 00:56:21 +00:00 · 9248e0f2a1
commit 9248e0f2a1
parent 5bb3c7851e b788946b9e
1 changed files with 88 additions and 84 deletions
--- a/README.md
+++ b/README.md
@ -1,84 +1,88 @@
-# Unlock Music 音乐解锁
+# Unlock Music 音乐解锁
-
+
- 在浏览器中解锁加密的音乐文件。 Unlock encrypted music file in the browser.
+[![Build Status](https://ci.unlock-music.dev/api/badges/um/web/status.svg)](https://ci.unlock-music.dev/um/web)
- Unlock Music 项目是以学习和技术研究的初衷创建的，修改、再分发时请遵循[授权协议]。
+
- Unlock Music 的 CLI 版本可以在 [unlock-music/cli] 找到，大批量转换建议使用 CLI 版本。
+- 在浏览器中解锁加密的音乐文件。 Unlock encrypted music file in the browser.
- 我们新建了 Telegram 群组 [`@unlock_music_chat`] ，欢迎加入！
+- Unlock Music 项目是以学习和技术研究的初衷创建的，修改、再分发时请遵循[授权协议]。
-
+- Unlock Music 的 CLI 版本可以在 [unlock-music/cli] 找到，大批量转换建议使用 CLI 版本。
-[授权协议]: https://git.unlock-music.dev/um/web/src/branch/master/LICENSE
+- 我们新建了 Telegram 群组 [`@unlock_music_chat`] ，欢迎加入！
-[unlock-music/cli]: https://git.unlock-music.dev/um/cli
+- CI 自动构建已经部署，可以在 [UM-Packages] 下载
-[`@unlock_music_chat`]: https://t.me/unlock_music_chat
+
-
+[授权协议]: https://git.unlock-music.dev/um/web/src/branch/master/LICENSE
-## 特性
+[unlock-music/cli]: https://git.unlock-music.dev/um/cli
-
+[`@unlock_music_chat`]: https://t.me/unlock_music_chat
-### 支持的格式
+[UM-Packages]: https://git.unlock-music.dev/um/-/packages/generic/web-build/
-
+
- [x] QQ 音乐 (.qmc0/.qmc2/.qmc3/.qmcflac/.qmcogg/.tkm)
+## 特性
- [x] Moo 音乐格式 (.bkcmp3/.bkcflac/...)
+
- [x] QQ 音乐 Tm 格式 (.tm0/.tm2/.tm3/.tm6)
+### 支持的格式
- [x] QQ 音乐新格式 (.mflac/.mgg/.mflac0/.mgg1/.mggl)
+
- [x] <ruby>QQ 音乐海外版<rt>JOOX Music</rt></ruby> (.ofl_en)
+- [x] QQ 音乐 (.qmc0/.qmc2/.qmc3/.qmcflac/.qmcogg/.tkm)
- [x] 网易云音乐格式 (.ncm)
+- [x] Moo 音乐格式 (.bkcmp3/.bkcflac/...)
- [x] 虾米音乐格式 (.xm)
+- [x] QQ 音乐 Tm 格式 (.tm0/.tm2/.tm3/.tm6)
- [x] 酷我音乐格式 (.kwm)
+- [x] QQ 音乐新格式 (.mflac/.mgg/.mflac0/.mgg1/.mggl)
- [x] 酷狗音乐格式 (.kgm/.vpr)
+- [x] <ruby>QQ 音乐海外版<rt>JOOX Music</rt></ruby> (.ofl_en)
-
+- [x] 网易云音乐格式 (.ncm)
-### 其他特性
+- [x] 虾米音乐格式 (.xm)
-
+- [x] 酷我音乐格式 (.kwm)
- [x] 在浏览器中解锁
+- [x] 酷狗音乐格式 (.kgm/.vpr)
- [x] 拖放文件
+
- [x] 批量解锁
+### 其他特性
- [x] 渐进式 Web 应用 (PWA)
+
- [x] 多线程
+- [x] 在浏览器中解锁
- [x] 写入元信息与专辑封面
+- [x] 拖放文件
-
+- [x] 批量解锁
-## 使用方法
+- [x] 渐进式 Web 应用 (PWA)
-
+- [x] 多线程
-### 使用预构建版本
+- [x] 写入元信息与专辑封面
-
+
- 从 [Release] 下载预构建的版本
+## 使用方法
-  - :warning: 本地使用请下载`legacy版本`（`modern版本`只能通过 **http(s)协议** 访问）
+
- 解压缩后即可部署或本地使用（**请勿直接运行源代码**）
+### 使用预构建版本
-
+
-[release]: https://git.unlock-music.dev/um/web/releases/latest
+- 从 [Release] 或 [CI 构建][UM-Packages] 下载预构建的版本
-
+  - :warning: 本地使用请下载`legacy版本`（`modern版本`只能通过 **http(s)协议** 访问）
-### 自行构建
+- 解压缩后即可部署或本地使用（**请勿直接运行源代码**）
-
+
-#### JS部分
+[release]: https://git.unlock-music.dev/um/web/releases/latest
-
+
- 环境要求
+### 自行构建
-  - nodejs (v16.x)
+
-  - npm
+#### JS部分
-
+
-1. 获取项目源代码后安装相关依赖：
+- 环境要求
-
+  - nodejs (v16.x)
-   ```sh
+  - npm
-   npm ci
+
-   ```
+1. 获取项目源代码后安装相关依赖：
-
+
-2. 然后进行构建：
+   ```sh
-
+   npm ci
-   ```sh
+   ```
-   npm run build
+
-   ```
+2. 然后进行构建：
-
+
-   - 构建后的产物可以在 `dist` 目录找到。
+   ```sh
-   - 如果是用于开发，可以执行 `npm run serve`。
+   npm run build
-
+   ```
-3. 如需构建浏览器扩展，构建成功后还需要执行：
+
-
+   - 构建后的产物可以在 `dist` 目录找到。
-   ```sh
+   - 如果是用于开发，可以执行 `npm run serve`。
-   npm run make-extension
+
-   ```
+3. 如需构建浏览器扩展，构建成功后还需要执行：
-
+
-#### WASM部分
+   ```sh
-
+   npm run make-extension
- 环境要求
+   ```
-  - Linux
+
-  - python3
+#### WASM部分
-
+
- 运行此目录下的build-wasm
+- 环境要求
-
+  - Linux
-   ```sh
+  - python3
-   ./scripts/build-wasm.sh
+
-   ```
+- 运行此目录下的build-wasm
   ```sh
   ./scripts/build-wasm.sh
   ```