Skip to content

Commit 4e6af64

Browse files
committed
update README.md
1 parent 0fa20ae commit 4e6af64

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,27 @@ The QR code that is printed to stdout encodes a http url which is typically of t
1111

1212
`http://{ip}:{port}/{send|receive}/[optional suffix]`
1313

14-
The maximum data that can be sent with each request is 1GB.
14+
## Current limitations
1515

16-
## Installation
16+
- The maximum data that can be sent with each request is 1GB which should satisfy most users.
17+
- Some browsers on iOS are unable to download the file. It always works with Safari but fails with Brave. The failed download might also occur on other Chromium-based iOS browsers.
1718

18-
## Usage
19+
## Installation options
20+
21+
### Install with cargo
22+
23+
swift_file is published on crates.io (https://crates.io/crates/swift_file) and can be directly installed.
24+
25+
```sh
26+
cargo install swift_file
27+
```
28+
29+
### Manual installation from an archive
30+
31+
[Releases](https://github.com/mateoradman/swift_file/releases) page provides an option to manually install the sf binary from an archive. The archive is available for Linux, MacOS, and Windows.
32+
Download, extract and move the binary to the desired directory, and set execution permissions.
33+
34+
## CLI Usage
1935

2036
```
2137
Usage: sf <COMMAND>

0 commit comments

Comments
 (0)