Skip to content

Commit 65111b9

Browse files
CrazyMrYanCrazyMrYan
committed
docs: update readme file
1 parent 7a302af commit 65111b9

2 files changed

Lines changed: 101 additions & 6 deletions

File tree

‎README-zh.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<p align="center">
2+
<a href="https://github.com/diskcloud/service">
3+
<img width="150" src="./public/logo.png">
4+
</a>
5+
</p>
6+
7+
<p align="center">
8+
<img alt="GitHub repo size" src="https://img.shields.io/github/repo-size/diskcloud/service">
9+
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-pr/diskcloud/service">
10+
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/diskcloud/service">
11+
</p>
12+
13+
## 支持系统 💻
14+
15+
| Linux | MacOS | Windows |
16+
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------ |
17+
| <img alt="Linux" width="35" src="./public/support-system/linux.svg"> | <img alt="MacOS" width="35" src="./public/support-system/macos.svg"> | <img alt="Windows" width="35" src="./public/support-system/windows.svg"> |
18+
19+
## 运行环境 📍
20+
21+
| Node | Npm | Yarn | MySQL | Redis |
22+
| -------- | ------- | -------- | -------- | ------- |
23+
| >=18.0.0 | >=8.0.0 | >=1.22.0 | >=5.7.44 | >=7.2.4 |
24+
25+
## 功能列表 📃
26+
27+
- [x] 文件上传
28+
- [x] 文件压缩
29+
- [x] 文件缩略图
30+
- [x] 文件临时存储
31+
- [x] 文件回收站
32+
- [x] 文件下载
33+
- [x] 文件编辑
34+
- [x] 文件共享
35+
- [x] 文件数据管理
36+
- [x] 用户单点登录（SSO）
37+
- [x] 用户注销
38+
- [x] 用户角色权限
39+
- [x] 用户禁用启用
40+
- [x] 一键启动项目
41+
- [x] 自动创建数据库
42+
43+
## 使用方法 😋
44+
45+
#### Linux
46+
47+
```shell
48+
./scripts/setup.sh
49+
```
50+
51+
#### Windows
52+
53+
```shell
54+
./scripts/setup.ps1
55+
```
56+
57+
## 贡献者 💪
58+
59+
<a href="https://github.com/diskcloud/service/graphs/contributors"><img src="https://opencollective.com/diskcloud/contributors.svg" /></a>
60+
61+
<a href="https://next.ossinsight.io/widgets/official/compose-activity-trends?repo_id=820362952" target="_blank" style="display: block" align="center">
62+
<picture>
63+
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/compose-activity-trends/thumbnail.png?repo_id=820362952&image_size=auto&color_scheme=dark">
64+
<img alt="Activity Trends of diskcloud/service - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-activity-trends/thumbnail.png?repo_id=820362952&image_size=auto&color_scheme=light" height="auto">
65+
</picture>
66+
</a>
67+
<br />
68+
<a href="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency?owner_id=11855343&period=past_28_days&activity=pull-requests" target="_blank" style="display: block" align="center">
69+
<picture>
70+
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency/thumbnail.png?owner_id=11855343&period=past_28_days&activity=pull-requests&image_size=3x9&color_scheme=dark">
71+
<img alt="Count of Pull requests Over Time" src="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency/thumbnail.png?owner_id=11855343&period=past_28_days&activity=pull-requests&image_size=3x9&color_scheme=light" height="auto">
72+
</picture>
73+
</a>
74+
75+
## 其他文档 📖
76+
77+
[Contribution Guide](./CONTRIBUTING.md) | [Security Policy](./SECURITY.md) | [Update Log](./CHANGELOG.md) | [Licence](./LICENSE)

‎README.md‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,37 @@
1010
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/diskcloud/service">
1111
</p>
1212

13-
## Support System💻
13+
## Support System 💻
1414

1515
| Liunx | MacOS | Windows |
1616
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------ |
1717
| <img alt="Liunx" width="35" src="./public/support-system/linux.svg"> | <img alt="MacOs" width="35" src="./public/support-system/macos.svg"> | <img alt="Windows" width="35" src="./public/support-system/windows.svg"> |
1818

19-
## Runtime Environment📍
19+
## Runtime Environment 📍
2020

2121
| Node | Npm | Yarn | MySQL | Redis |
2222
| -------- | ------- | -------- | -------- | ------- |
2323
| >=18.0.0 | >=8.0.0 | >=1.22.0 | >=5.7.44 | >=7.2.4 |
2424

25-
## Usage😋
25+
## Feature List 📃
26+
27+
- [x] File upload
28+
- [x] File compression
29+
- [x] File thumbnail
30+
- [x] Temporary storage of files
31+
- [x] File Recycle Bin
32+
- [x] File Download
33+
- [x] File editing
34+
- [x] File sharing
35+
- [x] File data management
36+
- [x] User SSO
37+
- [x] User logout
38+
- [x] User Role Permissions
39+
- [x] User disable enable
40+
- [x] One click start of project
41+
- [x] Automatic database creation
42+
43+
## Usage 😋
2644

2745
#### Liunx
2846

@@ -46,14 +64,14 @@
4664
<img alt="Activity Trends of diskcloud/service - Last 28 days" src="https://next.ossinsight.io/widgets/official/compose-activity-trends/thumbnail.png?repo_id=820362952&image_size=auto&color_scheme=light" height="auto">
4765
</picture>
4866
</a>
49-
67+
<br />
5068
<a href="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency?owner_id=11855343&period=past_28_days&activity=pull-requests" target="_blank" style="display: block" align="center">
5169
<picture>
5270
<source media="(prefers-color-scheme: dark)" srcset="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency/thumbnail.png?owner_id=11855343&period=past_28_days&activity=pull-requests&image_size=3x9&color_scheme=dark">
5371
<img alt="Count of Pull requests Over Time" src="https://next.ossinsight.io/widgets/official/analyze-org-activity-efficiency/thumbnail.png?owner_id=11855343&period=past_28_days&activity=pull-requests&image_size=3x9&color_scheme=light" height="auto">
5472
</picture>
5573
</a>
5674

57-
## Other Docs📖
75+
## Other Docs 📖
5876

59-
[贡献指南](./CONTRIBUTING.md) | [安全策略](./SECURITY.md) | [更新日志](./CHANGELOG.md) | [MIT license](./LICENSE)
77+
[贡献指南](./CONTRIBUTING.md) | [安全策略](./SECURITY.md) | [更新日志](./CHANGELOG.md) | [许可证](./LICENSE)

0 commit comments

Comments
 (0)