Skip to content

Commit

Permalink
Fix README
Browse files Browse the repository at this point in the history
  • Loading branch information
joaofl committed Jan 3, 2025
1 parent 4da4d04 commit 8c91784
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![](https://deps.rs/repo/github/joaofl/quick-serve/status.svg)](https://deps.rs/repo/github/joaofl/quick-serve)

<p align="center">
<p align="center"> <img src="media/logo.png" alt="Logo" width="600"/> </p>
<p align="center"> <img src="media/logo.png" alt="Logo" width="500"/> </p>
</p>

# Quick-serve
Expand All @@ -16,7 +16,8 @@ It can be used both headless or for an even more friendly experience, it can be
<!-- ![alt text](media/screenshot.png "Screenshot") -->

<p align="center">
<img src="media/screenshot.png" alt="Screenshot" width="600"/>
<img src="media/screenshoot-light.png" alt="Screenshot" width="250"/>
<img src="media/screenshoot-dark.png" alt="Screenshot" width="250"/>
</p>

## Motivation
Expand All @@ -36,19 +37,15 @@ protocol-agnostic solution.
## Usage

```shell
Quick-serve

Usage: quick-serve [OPTIONS]

Options:
--headless Headless
-b, --bind-ip=<IP> Bind IP [default: 127.0.0.1]
-d, --serve-dir=<PATH> Directory to serve [default: /tmp/]
-v, --verbose... Verbose logging
--http[=<PORT>] Start the HTTP server [default port: 8080]
--ftp[=<PORT>] Start the FTP server [default port: 2121]
--tftp[=<PORT>] Start the TFTP server [default port: 6969]
--dhcp Start the DHCP server
--http[=<PORT>] Start the HTTP server [default port: 8080]
--ftp[=<PORT>] Start the FTP server [default port: 2121]
--tftp[=<PORT>] Start the TFTP server [default port: 6969]
--dhcp[=<PORT>] Start the DHCP server [default port: 6767]
-h, --help Print help (see more with '--help')
-V, --version Print version
```
Expand Down Expand Up @@ -116,8 +113,8 @@ cargo test
- [x] FTP
- [x] HTTP
- [x] TFTP
- [ ] HTTPS
- [x] DHCP
- [ ] HTTPS
- [ ] SFTP
- [ ] NFS
- [ ] SAMBA
Expand Down
Binary file added media/screenshoot-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added media/screenshoot-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed media/screenshot.png
Binary file not shown.

0 comments on commit 8c91784

Please sign in to comment.