update: README

This commit is contained in:
XZB
2023-05-22 00:45:23 +08:00
parent eb6c55cfd4
commit 0d4e04dc5c
17 changed files with 41 additions and 19 deletions

View File

@@ -34,6 +34,8 @@
**数据无价,在点击任何按钮、输入任何命令之前,请三思。**
如果你发现了任何安全问题,请**不要**发布issue并立即[**联系我**](mailto:i@1248.ink)。
---
## 快速开始
@@ -54,7 +56,7 @@
```json
{
"listen": ":8000",
"salt": "123456abcdefg",
"salt": "123456abcdef",
"auth": {
"username": "password"
},
@@ -70,7 +72,7 @@
* `salt` `必填`修改后需要重新部署客户端长度不大于24
* `auth` `选填`,格式为 `用户名:密码`
* 密码强烈建议使用hash加密
* 格式为`$算法$密文`,例如`$sha256$123456abcdefg`
* 格式为`$算法$密文`,例如`$sha256$11223344556677AABBCCDDEEFF`
* 支持的算法有:`sha256``sha512`和`bcrypt`
* 如果不按照格式填写,将会被视为明文密码
* `log` `选填`,日志配置
@@ -110,19 +112,19 @@
## 截图
![overview](./screenshots/overview.ZH.png)
![overview](./docs/overview.ZH.png)
![terminal](./screenshots/terminal.ZH.png)
![terminal](./docs/terminal.ZH.png)
![desktop](./screenshots/desktop.ZH.png)
![desktop](./docs/desktop.ZH.png)
![procmgr](./screenshots/procmgr.ZH.png)
![procmgr](./docs/procmgr.ZH.png)
![explorer](./screenshots/explorer.ZH.png)
![explorer](./docs/explorer.ZH.png)
![overview.cpu](./screenshots/overview.cpu.ZH.png)
![overview.cpu](./docs/overview.cpu.ZH.png)
![explorer.editor](./screenshots/explorer.editor.ZH.png)
![explorer.editor](./docs/explorer.editor.ZH.png)
---
@@ -184,6 +186,15 @@ $ ./scripts/build.server.sh
---
## 赞助
项目是免费公开的,它的成长离不开您的支持,请考虑赞助我让这个项目变得更好。
您可以使用微信扫码赞助。
![sponsor](./docs/sponsor.jpeg)
---
## 项目依赖
Spark使用了许多第三方的开源项目。
@@ -225,7 +236,7 @@ Spark使用了许多第三方的开源项目。
### 感谢
* [natpass](https://github.com/lwch/natpass) (MIT License)
* 图像差异算法部分参考了natpass项目的有关部分
* 图像差异算法部分参考了natpass项目的有关逻辑
---

View File

@@ -36,6 +36,8 @@ server forever.
**YOUR DATA IS PRICELESS. THINK TWICE BEFORE YOU CLICK ANY BUTTON OR ENTER ANY COMMAND.**
If you found any security vulnerability, please **DO NOT** open an issue and immediately contact me via [**email**](mailto:i@1248.ink).
---
## Quick start
@@ -59,7 +61,7 @@ Example:
```json
{
"listen": ":8000",
"salt": "123456abcdefg",
"salt": "123456abcdef",
"auth": {
"username": "password"
},
@@ -76,7 +78,7 @@ Example:
* after modification, you need to re-generate all clients
* `auth` `optional`, format: `username:password`
* hashed-password is highly recommended
* format: `$algorithm$hashed-password`, example: `$sha256$123456abcdefg`
* format: `$algorithm$hashed-password`, example: `$sha256$11223344556677AABBCCDDEEFF`
* supported algorithms: `sha256`, `sha512`, `bcrypt`
* if you don't follow the format, password will be treated as plain-text
* `log` `optional`
@@ -116,19 +118,19 @@ Example:
## Screenshots
![overview](./screenshots/overview.png)
![overview](./docs/overview.png)
![terminal](./screenshots/terminal.png)
![terminal](./docs/terminal.png)
![desktop](./screenshots/desktop.png)
![desktop](./docs/desktop.png)
![procmgr](./screenshots/procmgr.png)
![procmgr](./docs/procmgr.png)
![explorer](./screenshots/explorer.png)
![explorer](./docs/explorer.png)
![overview.cpu](./screenshots/overview.cpu.png)
![overview.cpu](./docs/overview.cpu.png)
![explorer.editor](./screenshots/explorer.editor.png)
![explorer.editor](./docs/explorer.editor.png)
---
@@ -194,6 +196,15 @@ Finally, run the executable file in that directory.
---
## Sponsor
The project is free and open to the public, and its growth cannot be achieved without your support. Please consider sponsoring me to make this project even better.
You can sponsor me via WeChat.
![sponsor](./docs/sponsor.jpeg)
---
## Dependencies
Spark contains many third-party open-source projects.

View File

Before

Width:  |  Height:  |  Size: 925 KiB

After

Width:  |  Height:  |  Size: 925 KiB

View File

Before

Width:  |  Height:  |  Size: 808 KiB

After

Width:  |  Height:  |  Size: 808 KiB

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 86 KiB

View File

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 49 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 39 KiB

View File

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View File

Before

Width:  |  Height:  |  Size: 55 KiB

After

Width:  |  Height:  |  Size: 55 KiB

View File

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

BIN
docs/sponsor.jpeg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 103 KiB

View File

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

View File

Before

Width:  |  Height:  |  Size: 37 KiB

After

Width:  |  Height:  |  Size: 37 KiB