Skip to content

Commit 2ddf510

Browse files
committed
chore: update README
1 parent 3873970 commit 2ddf510

File tree

3 files changed

+37
-4
lines changed

3 files changed

+37
-4
lines changed

README.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,50 @@
1-
# Sharing GUI
1+
<p align="center">
2+
<br>
3+
<img src="assets/header.png" width="200" style="max-width: 100%;" />
4+
<br><br><br>
5+
</p>
6+
7+
Easily share files to multiple devices on the LAN/Public Network.
28

3-
> Easily share files to multiple devices on the LAN/Public Network.
9+
# Sharing GUI
410

511
The Sharing GUI is a client that is used to share files across multiple devices (iOS, Android, macOS, Windows, Linux...)
612

713
**Only one client is required**, other devices use WEB. (client support macOS, Windos, Linux)
814

9-
Based to [parvardegr/sharing](https://github.com/parvardegr/sharing)
15+
Start with [parvardegr/sharing](https://github.com/parvardegr/sharing) and then used [yunying1/sharing](https://github.com/yunying1/sharing)
16+
17+
## Features
18+
- Download your files on other devices
19+
- Accept files on other devices
20+
- Access your clipboard on other devices
21+
- support LAN/Public Network
22+
- support identity authentication
1023

1124
![Preview](assets/app.png)
1225

1326
# Usage
1427

28+
## Installation
29+
30+
```bash
31+
yarn
32+
```
33+
34+
## Development
35+
36+
```bash
37+
yarn dev
38+
```
39+
40+
## Distribution
41+
1542
```bash
16-
yarn && yarn dev
43+
yarn make
1744
```
45+
46+
## Custom Core
47+
48+
if your need custom core, visit this repo [yunying1/sharing](https://github.com/yunying1/sharing)
49+
50+
I use [pkg](https://github.com/vercel/pkg) package it into binary files

assets/app.png

2.19 KB
Loading

assets/header.png

334 KB
Loading

0 commit comments

Comments
 (0)