docs: document (#7)

Author: yinyanfr

README.md

@@ -1,2 +1,85 @@
 # bili-pc-mp4
-MP4 convertor for videos downloaded by the Bilibili pc application.
+
+[![npm](https://img.shields.io/npm/v/bili-pc-mp4.svg?style=flat-square)](https://www.npmjs.com/package/bili-pc-mp4)
+![license](https://img.shields.io/npm/l/bili-pc-mp4.svg?style=flat-square)
+![size](https://img.shields.io/github/repo-size/yinyanfr/bili-pc-mp4?style=flat-square)
+[![GitHub release](https://img.shields.io/github/release/yinyanfr/bili-pc-mp4.svg?style=flat-square)](https://github.com/yinyanfr/bili-pc-mp4/releases/latest)
+
+```bash
+npx bili-pc-mp4 ~/Movies/bilibili
+```
+
+中文文档 | [English Document](./docs/README.en.md)
+
+`bili-pc-mp4` 是用于将「Bilibili 桌面客户端」(Windows（非 UMP）, Mac 版)下载的视频转换为 MP4 格式的工具。
+
+**请注意 `bili-pc-mp4` 并非下载器**，您需要先通过「Bilibili 桌面客户端」对视频进行「离线缓存」。
+
+`bili-pc-mp4` 仅支持由「Bilibili 桌面客户端」下载的视频，不支持其它平台客户端。
+
+您需要先[安装 ffmpeg](./docs/ffmpeg.md).
+
+## :star2: 特性
+
+- 解密并合并视频，不损失音画质
+- 支持批量转换多个视频
+- 支持查看视频信息
+- 简单易用的命令行工具
+- 低内存占用
+
+## :wrench: 命令行工具
+
+### 转换视频
+
+您可以使用页首的简单命令，或使用完整命令：
+
+```bash
+npx bili-pc-mp4 convert -i ~/Movies/bilibili -o ~/Movies/converted
+```
+
+命令行支持如下选项：
+
+| 名称                | 类型 | 简介                                                                           |
+| ------------------- | ---- | ------------------------------------------------------------------------------ |
+| `--input, -i`       | 路径 | 指定要转换的视频位置，可以是单个视频的文件夹，也可以是包含多个视频的文件夹。   |
+| `--output, -o`      | 路径 | 指定输出视频的位置，默认为当前位置。                                           |
+| `--page-number, -p` |      | 是否在输出的视频文件名前加入分p 序号。                                         |
+| `--silience, -s`    |      | 是否取消终端输出。                                                             |
+| `--buffer-size, -b` | 数字 | 指定读取文件流的分块大小（KB），默认为64 MB，为使解密有效，该值应不少于 16 KB. |
+
+你可以输入以下命令查看完整帮助信息和使用示例：
+
+```bash
+npx bili-pc-mp4 help
+```
+
+### 查看视频信息
+
+```bash
+npx bili-pc-mp4 list ~/Movies/bilibili
+```
+
+## :book: 作为库使用
+
+您也可以讲 `bili-pc-mp4` 作为库使用，`bili-pc-mp4` 使用 CommonJS.
+
+`bili-pc-mp4` 完整使用 JSDoc，各功能及选项与命令行一致。
+
+```bash
+npm i bili-pc-mp4
+```
+
+```typescript
+import { listVideos, processFolder } from 'bili-pc-mp4';
+
+// 查看视频信息
+await listVideos('./bilibili');
+
+// 转换视频
+await processFolder('./bilibili', {
+  output: './converted',
+  pageNumber: true,
+  silence: true,
+  bufferSize: 64 * 1024,
+});
+```

docs/README.en.md

@@ -0,0 +1,79 @@
+# bili-pc-mp4
+
+[![npm](https://img.shields.io/npm/v/bili-pc-mp4.svg?style=flat-square)](https://www.npmjs.com/package/bili-pc-mp4)
+![license](https://img.shields.io/npm/l/bili-pc-mp4.svg?style=flat-square)
+![size](https://img.shields.io/github/repo-size/yinyanfr/bili-pc-mp4?style=flat-square)
+[![GitHub release](https://img.shields.io/github/release/yinyanfr/bili-pc-mp4.svg?style=flat-square)](https://github.com/yinyanfr/bili-pc-mp4/releases/latest)
+
+[中文文档](../README.md) | English Document
+
+`bili-pc-mp4` is a tool for converting videos downloaded from the "Bilibili Desktop Client" (Windows (non-UMP), Mac version) into MP4 format.
+
+Please note that `bili-pc-mp4` is not a downloader, and you need to first use the "Bilibili Desktop Client" to perform "offline caching" of the videos.
+
+`bili-pc-mp4 only` supports videos downloaded using the "Bilibili Desktop Client" and does not support other platform clients.
+
+You need to first [install ffmpeg](./ffmpeg.en.md).
+
+## :star2: Features
+
+- Decrypts and merges videos without loss of audio and video quality.
+- Supports batch conversion of multiple videos.
+- Supports viewing video information.
+- Simple and easy-to-use command-line tool.
+- Low memory usage.
+
+## :wrench: Command-Line Tool
+
+### Convert Videos
+
+You can use the simple command at the top of the page or use the complete command:
+
+```bash
+npx bili-pc-mp4 convert -i ~/Movies/bilibili -o ~/Movies/converted
+```
+
+| Name                | Type   | Description                                                                                                                                       |
+| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `--input, -i`       | Path   | Specifies the location of the videos to be converted. It can be a folder containing a single video or multiple videos.                            |
+| `--output, -o`      | Path   | Specifies the output location for the videos. Defaults to the current location.                                                                   |
+| `--page-number, -p` |        | Whether to include the page number (分p) before the output video filename.                                                                        |
+| `--silence, -s`     |        | Whether to suppress terminal output.                                                                                                              |
+| `--buffer-size, -b` | Number | Specifies the block size (in KB) for reading file streams. Defaults to 64 MB. For effective decryption, this value should not be less than 16 KB. |
+
+You can input the following command to see complete help information and usage examples:
+
+```bash
+npx bili-pc-mp4 help
+```
+
+### View Video Information
+
+```bash
+npx bili-pc-mp4 list ~/Movies/bilibili
+```
+
+## :book: Using as a Library
+
+You can also use `bili-pc-mp4` as a library; bili-pc-mp4 uses CommonJS.
+
+`bili-pc-mp4` has complete JSDoc, and its features and options are consistent with the command-line.
+
+```bash
+npm i bili-pc-mp4
+```
+
+```typescript
+import { listVideos, processFolder } from 'bili-pc-mp4';
+
+// View video information
+await listVideos('./bilibili');
+
+// Convert videos
+await processFolder('./bilibili', {
+  output: './converted',
+  pageNumber: true,
+  silence: true,
+  bufferSize: 64 * 1024,
+});
+```

docs/ffmpeg.en.md

@@ -0,0 +1,23 @@
+# Installing ffmpeg
+
+[中文文档](./ffmpeg.md) | English Document
+
+You can directly obtain it from the [ffmpeg project website](https://ffmpeg.org/download.html).
+
+Alternatively, you can use a package manager for your operating system.
+
+## Windows
+
+You can use [Chocolatey](https://chocolatey.org/install), and install ffmpeg with the following command.
+
+```bash
+choco install ffmpeg
+```
+
+## Mac OS
+
+You can use [Homebrew](https://brew.sh/), and install ffmpeg with the following command.
+
+```bash
+brew install ffmpeg
+```

docs/ffmpeg.md

@@ -0,0 +1,23 @@
+# 安装 ffmpeg
+
+中文文档 | [English Document](./ffmpeg.en.md)
+
+您可以直接从 [ffmpeg 项目网站](https://ffmpeg.org/download.html)获取。
+
+或使用适用于您操作系统的管理器。
+
+## Windows
+
+您可以使用 [Chocolatey](https://chocolatey.org/install)，并通过如下命令安装 ffmpeg.
+
+```bash
+choco install ffmpeg
+```
+
+## Mac OS
+
+您可以使用 [Homebrew](https://brew.sh/)，并通过如下命令安装 ffmpeg.
+
+```bash
+brew install ffmpeg
+```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bili-pc-mp4",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "MP4 convertor for videos downloaded by the Bilibili pc application.",
   "main": "dist/index.js",
   "bin": "dist/cli/index.js",
@@ -12,7 +12,10 @@
     "lint-staged": "lint-staged",
     "prepare": "husky install"
   },
-  "keywords": [],
+  "keywords": [
+    "bilibili",
+    "bilibili-download"
+  ],
   "author": "",
   "repository": {
     "type": "git",

src/core/index.ts

@@ -82,7 +82,7 @@ async function analyseFolder(dirPath: string): Promise<Task[]> {
  * @param {number} [bufferSize=65536] - The size of the buffer for reading the file.
  * @returns {ReadStream} A readable stream containing the decrypted file content.
  */
-function decryptedBuffer(filePath: string, bufferSize = 1024 * 64) {
+function decryptedBuffer(filePath: string, bufferSize = 64 * 1024) {
   const readStream = createReadStream(filePath, { highWaterMark: bufferSize });
   let isFirstChunk = true;