Skip to content

Commit d7aa213

Browse files
committed
docs: add qifi cli usecase
1 parent 9c37cd3 commit d7aa213

File tree

3 files changed

+22
-1
lines changed

3 files changed

+22
-1
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ Stream data through multiple QRCodes
3333

3434
## Sub-packages
3535

36+
- [QiFi CLI](./packages/cli) - CLI for streaming QR code file transmission
3637
- [luby-transform](./packages/luby-transform) - Luby Transform encoding and decoding
3738
- [@qifi/generate](./packages/generate) - Stream Generated QR Codes for data transmission
3839

packages/cli/README.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,26 @@ Stream Generated QR Codes for file transmission in your terminal
3131

3232
## Usage
3333

34+
Get document
35+
36+
```bash
37+
npx qifi --help
38+
```
39+
40+
Stream file
41+
42+
```bash
43+
npx qifi ./file.txt
44+
```
45+
46+
Stream file with custom chunk size
47+
3448
```bash
35-
npx qifi <file> [options]
49+
npx qifi -ICS=1000 ./file.txt
3650
```
51+
52+
You can use any scanner to scan the dynamic QR code. This will redirect to [a scanner website in the browser](https://qrss.netlify.app) to actually obtain the file data from the QR code.
53+
54+
## Demo
55+
56+
![Demo](../../public/qifi-cli-demo.jpg)

public/qifi-cli-demo.jpg

90.5 KB
Loading

0 commit comments

Comments
 (0)