其它: 移除主页说明失效的链接、更名 .github 到 .gitlab、加入 issue 模板。

2025-11-16 21:54:23 +00:00 · 2022-11-21 19:39:02 +00:00
parent 2872ceb3bb
commit fd5c0957a2
6 changed files with 135 additions and 432 deletions
--- a/README.md
+++ b/README.md
@@ -1,92 +1,70 @@
-# Unlock Music 音乐解锁
-
- 在浏览器中解锁加密的音乐文件。 Unlock encrypted music file in the browser.
- Unlock Music 项目是以学习和技术研究的初衷创建的，修改、再分发时请遵循 [License][license]
- Unlock Music 的 CLI 版本可以在 [unlock-music/cli][repo_cli] 找到，大批量转换建议使用 CLI 版本。
- 我们新建了 Telegram 群组 [`@unlock_music_chat`][tg_group] ，欢迎加入！
- [相关的其他项目][related_projects]
-
-![Test Build](https://github.com/unlock-music/unlock-music/workflows/Test%20Build/badge.svg)
-![GitHub releases](https://img.shields.io/github/downloads/unlock-music/unlock-music/total)
-![Docker Pulls](https://img.shields.io/docker/pulls/ix64/unlock-music)
-
-[license]: https://github.com/unlock-music/unlock-music/blob/master/LICENSE
-
-[repo_cli]: https://github.com/unlock-music/cli
-
-[tg_group]: https://t.me/unlock_music_chat
-
-[related_projects]: https://github.com/unlock-music/unlock-music/wiki/和UnlockMusic相关的项目
-
-## 特性
-
-### 支持的格式
-
- [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] 网易云音乐格式 (.ncm)
- [x] 虾米音乐格式 (.xm)
- [x] 酷我音乐格式 (.kwm)
- [x] 酷狗音乐格式 (.kgm/.vpr) ([CLI 版本][kgm_cli])
-
-[kgm_cli]: https://github.com/unlock-music/unlock-music/wiki/其他音乐格式工具#酷狗音乐-kgmvpr解锁工具
-
-[joox_wiki]: https://github.com/unlock-music/joox-crypto/wiki/加密格式
-
-### 其他特性
-
- [x] 在浏览器中解锁
- [x] 拖放文件
- [x] 批量解锁
- [x] 渐进式 Web 应用 (PWA)
- [x] 多线程
- [x] 写入Meta和封面图片
-
-## 使用方法
-
-### 安装浏览器扩展
-
-[![Chrome Web Store](https://storage.googleapis.com/chrome-gcs-uploader.appspot.com/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png)](https://chrome.google.com/webstore/detail/gldlhhhmienbhlpkfanjpmffdjblmegd)
-[<img src="https://developer.microsoft.com/en-us/store/badges/images/Chinese_Simplified_get-it-from-MS.png" height="60" alt="Microsoft Edge Addons"/>](https://microsoftedge.microsoft.com/addons/detail/ggafoipegcmodfhakdkalpdpcdkiljmd)
-[![Firefox Browser Addons](https://ffp4g1ylyit3jdyti1hqcvtb-wpengine.netdna-ssl.com/addons/files/2015/11/get-the-addon.png)](https://addons.mozilla.org/zh-CN/firefox/addon/unlock-music/)
-
-### 使用已构建版本
-
- 从[GitHub Release](https://github.com/unlock-music/unlock-music/releases/latest)下载已构建的版本
-  - 本地使用请下载`legacy版本`（`modern版本`只能通过 **http(s)协议** 访问）
- 解压缩后即可部署或本地使用（**请勿直接运行源代码**）
-
-### 使用 Docker 镜像
-
-```shell
-docker run --name unlock-music -d -p 8080:80 ix64/unlock-music
-```
-
-### 自行构建
-
- 环境要求
-  - nodejs (v16.x)
-  - npm
-
-1. 获取项目源代码后安装相关依赖：
-
-   ```sh
-   npm ci
-   ```
-
-2. 然后进行构建。编译后的文件保存到 dist 目录下：
-
-   ```sh
-   npm run build
-   ```
-
- 如果是用于开发，可以执行 `npm run serve`。
-
-3. 如需构建浏览器扩展，build 完成后还需要执行：
-
-   ```sh
-   npm run make-extension
-   ```
+# Unlock Music 音乐解锁
+
+- 在浏览器中解锁加密的音乐文件。 Unlock encrypted music file in the browser.
+- Unlock Music 项目是以学习和技术研究的初衷创建的，修改、再分发时请遵循[授权协议]。
+- Unlock Music 的 CLI 版本可以在 [unlock-music/cli] 找到，大批量转换建议使用 CLI 版本。
+- 我们新建了 Telegram 群组 [`@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
+
+## 特性
+
+### 支持的格式
+
+- [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] 网易云音乐格式 (.ncm)
+- [x] 虾米音乐格式 (.xm)
+- [x] 酷我音乐格式 (.kwm)
+- [x] 酷狗音乐格式 (.kgm/.vpr)
+
+### 其他特性
+
+- [x] 在浏览器中解锁
+- [x] 拖放文件
+- [x] 批量解锁
+- [x] 渐进式 Web 应用 (PWA)
+- [x] 多线程
+- [x] 写入元信息与专辑封面
+
+## 使用方法
+
+### 使用预构建版本
+
+- 从 [Release] 下载预构建的版本
+  - :warning: 本地使用请下载`legacy版本`（`modern版本`只能通过 **http(s)协议** 访问）
+- 解压缩后即可部署或本地使用（**请勿直接运行源代码**）
+
+[release]: https://git.unlock-music.dev/um/web/releases/latest
+
+### 自行构建
+
+- 环境要求
+  - nodejs (v16.x)
+  - npm
+
+1. 获取项目源代码后安装相关依赖：
+
+   ```sh
+   npm ci
+   ```
+
+2. 然后进行构建：
+
+   ```sh
+   npm run build
+   ```
+
+   - 构建后的产物可以在 `dist` 目录找到。
+   - 如果是用于开发，可以执行 `npm run serve`。
+
+3. 如需构建浏览器扩展，构建成功后还需要执行：
+
+   ```sh
+   npm run make-extension
+   ```