Skip to content

Commit 6e90722

Browse files
committed
docs(README): 更新项目文档- 重新组织文档结构,增加更多视觉元素
- 添加新功能和预览图片 -增加免责声明和更多信息
1 parent 18611bc commit 6e90722

File tree

10 files changed

+62
-13
lines changed

10 files changed

+62
-13
lines changed

README.md

Lines changed: 62 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,85 @@
1-
# VRCM
2-
## A Multi-Platform friend "monitor" for VRChat.
1+
<div align="center">
2+
3+
# <img src="image/Logo.png" width="50" height="50" alt="logo"/> VRCM
34

45
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6+
[![GitHub release](https://img.shields.io/github/release/vrcm-team/VRCM.svg)](https://github.com/vrcm-team/VRCM/releases/latest)
7+
[![Downloads](https://img.shields.io/github/downloads/vrcm-team/VRCM/total?color=6451f1)](https://github.com/vrcm-team/VRCM/releases/latest)
8+
9+
10+
## A Multi-Platform friend "monitor" for VRChat.
11+
12+
</div>
13+
<div align="center">
14+
15+
## Features
16+
17+
</div>
518

6-
## Features:
719
- Multi-platform support (Android, iOS, Desktop?)
20+
- Change Account
821
- Friend Location
9-
- Friend list
10-
- Friend profile
22+
- Friend List
23+
- User Profile
24+
- User Search
1125
- Notification actions( friend request, mark as read, hide...)
1226
- Settings(i8n, theme...)
13-
## Preview:
27+
<div align="center">
28+
29+
## Preview
30+
31+
</div>
32+
33+
### Multi-platform Preview:
34+
35+
<div align="center">
36+
37+
![MultiPlatformPreview.png](image/MultiPlatformPreview.png)
1438

15-
![PreviewLocation.png](image/PreviewLocation.png)
16-
![PreviewFriendList.png](image/PreviewFriendList.png)
17-
![PreviewSettings.png](image/PreviewSettings.png)
18-
![PreviewProfile.png](image/PreviewProfile.png)
39+
</div>
1940

20-
## TODO:
41+
### UI Preview:
42+
43+
<div align="center">
44+
45+
![UIPreview.png](image/UIPreview.png)
46+
47+
</div>
48+
49+
<div align="center">
50+
51+
## TODO
52+
53+
</div>
2154

2255
- Friend Profile actions(add friend, block...)
2356
- World Profile UI(world name, description, tags...) and actions(favorite...)
2457
- Group Profile UI(group name, description, tags...) and actions(favorite...)
2558
- Notifications UI and actions(mark as read, delete...)
2659
- Support for System Notifications
2760

28-
## Dependencies:
61+
<div align="center">
62+
63+
## Disclaimer
64+
65+
</div>
66+
67+
VRCM is not affiliated with VRChat Inc and does not represent the views or opinions of VRChat Inc.
68+
VRCM does not store or collect any data outside the confines of your device.
69+
The author of this application is not responsible for any damages caused by this application.
70+
VRCM does not modify or tamper with the game and does not violate [VRChat's Terms of Service.](https://hello.vrchat.com/legal).
71+
72+
<div align="center">
73+
74+
## Dependencies
75+
76+
</div>
77+
2978
The app uses the following multiplatform dependencies in its implementation:
3079
- [Ktor](https://ktor.io/) for networking
3180
- [kotlinx.serialization](https://github.com/Kotlin/kotlinx.serialization) for JSON handling
3281
- [Koin](https://github.com/InsertKoinIO/koin) for dependency injection
3382
- [Voyager](https://github.com/adrielcafe/voyager) for shared Model implementations in common code and Navigation
3483
- [Sultiplatform-Settings](https://github.com/russhwolf/multiplatform-settings) for Key-Value preferences
3584
- [Jetpack Compose](https://developer.android.com/jetpack/compose)
36-
- [Coil](https://github.com/coil-kt/coil) for image loading
85+
- [Coil](https://github.com/coil-kt/coil) for image loading

image/Logo.png

29.3 KB
Loading

image/MultiPlatformPreview.png

579 KB
Loading

image/PreviewFriendList.png

-396 KB
Binary file not shown.

image/PreviewLocation.png

-301 KB
Binary file not shown.

image/PreviewProfile.png

-325 KB
Binary file not shown.

image/PreviewSettings.png

-264 KB
Binary file not shown.

image/UIPreview.png

1.56 MB
Loading

image/appPreview.png

-603 KB
Binary file not shown.

0 commit comments

Comments
 (0)