Skip to content

Commit 845bcd4

Browse files
committed
feat: update README with English and Chinese documentation
1 parent db077c5 commit 845bcd4

File tree

2 files changed

+51
-4
lines changed

2 files changed

+51
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,30 @@
1-
## resource-save-script
1+
English | [中文](./README_zh.md)
22

3-
### install
3+
# Resource Saving Script
4+
5+
A simple but powerful Node.js script that runs a local web server and automatically downloads missing resources.
6+
7+
### Global Installation
48

59
```bash
610
npm install -g resource-save-script
711
```
812

9-
### usage
13+
### Usage
14+
15+
Once installed, you can use the `h` command in your terminal.
1016

1117
```bash
12-
h 4000 https://your-resource-domain.com
18+
# Run on a custom port (e.g., 8080)
19+
h 8080
20+
21+
# Run on the default port (4000)
22+
h
23+
```
24+
25+
After running the command, the script will prompt you to enter the base URL of the remote server where the resources are located.
26+
27+
```text
28+
→ Please enter the base URL for resources: https://your-remote-server.com
1329
```
30+
The local server will then start, and any missing files will be downloaded automatically.

README_zh.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
中文 | [English](./README.md)
2+
3+
# 资源保存脚本
4+
5+
一个简单但功能强大的 Node.js 脚本,可以运行一个本地 Web 服务器并自动下载缺失的资源。
6+
7+
### 全局安装
8+
9+
```bash
10+
npm install -g resource-save-script
11+
```
12+
13+
### 使用方法
14+
15+
安装后,您可以在终端中使用 `h` 命令。
16+
17+
```bash
18+
# 使用自定义端口 (例如 8080)
19+
h 8080
20+
21+
# 使用默认端口 (4000)
22+
h
23+
```
24+
25+
运行命令后,脚本将提示您输入存放资源的远程服务器的基础 URL。
26+
27+
```text
28+
→ 请输入资源所在的根 URL: https://your-remote-server.com
29+
```
30+
之后本地服务器将启动,并自动下载任何缺失的文件。

0 commit comments

Comments
 (0)