Skip to content

Commit 0a54e77

Browse files
committed
doc: modified read me content
1 parent 786b7c9 commit 0a54e77

File tree

1 file changed

+26
-1
lines changed

1 file changed

+26
-1
lines changed

README.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,27 @@
11
# FileFlow
2-
Simple, Fast, and Secure File Transfer for Everyone
2+
Transfer files between two devices via web browser
3+
4+
## Quick Start
5+
6+
### Deployment
7+
8+
```shell
9+
# Linux
10+
wget -c https://github.com/debugdoctor/FileFlow/releases/download/v0.1.1/FileFlow-linux-x86_64 -O FileFlow
11+
12+
# Windows
13+
wget -c https://github.com/debugdoctor/FileFlow/releases/download/v0.1.1/FileFlow-windows-x86_64.exe -O FileFlow.exe
14+
```
15+
16+
### Usage
17+
Use the following command to start FileFlow serrver
18+
19+
```shell
20+
# Linux
21+
./FileFlow > FIleFlow.log 2>&1 & echo $! > FileFlow.pid
22+
23+
# Windows
24+
start /b FileFlow.exe > FileFlow.log 2>&1
25+
```
26+
27+
Open your browser and visit `http://server_ip:5000/upload` then you can upload files and follow the instructions to download files.

0 commit comments

Comments
 (0)