Skip to content

Commit

Permalink
Improve README and bump env_logger
Browse files Browse the repository at this point in the history
  • Loading branch information
joaofl committed Jan 22, 2024
1 parent 7a3359c commit b2ed9bb
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 11 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ tower = { version = "0.4.13", features = ["full"] }

# Log related
log = "0.4.20"
env_logger = "0.10.1"
env_logger = "0.11.0"

# For the headless version
clap = { version = "4.4.13", features = ["derive"] }
Expand Down
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,18 @@ multiple protocols, was headless, and supported various platforms. Unlike many d
Windows or Linux, with or without a UI, my app aims to bridge the gap by offering a versatile, multi-platform, and
protocol-agnostic solution.

## Install

```sh
cargo install quick-serve
```

## Build

```sh
cargo build --release
```

## Usage

```shell
Expand Down Expand Up @@ -54,25 +66,20 @@ Options:
Print version
```

## Features and To-do List
## Features

- [x] FTP
- [x] HTTP
- [ ] HTTPS
- [x] TFTP
- [ ] DHCP
- [ ] SFTP
- [x] Headless version
- [ ] User interface
- [ ] Serve N files and exit
- [ ] Timeout
- [ ] Show transfer rate
- [ ] Serve for t seconds and exit
- [ ] Report transfer rate
- [ ] Color-code logs according to protocol
- [ ] Add logs filter levels and source
- [ ] Add log filtering options
- [ ] Refine on each protocol's specific logs

## Compiling on Ubuntu 22.04

Build and run:
```bash
cargo build --release
```

0 comments on commit b2ed9bb

Please sign in to comment.