Skip to content

Commit

Permalink
docs: add qifi cli usecase
Browse files Browse the repository at this point in the history
  • Loading branch information
LittleSound committed Oct 11, 2024
1 parent 9c37cd3 commit d7aa213
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Stream data through multiple QRCodes

## Sub-packages

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

Expand Down
22 changes: 21 additions & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,26 @@ Stream Generated QR Codes for file transmission in your terminal

## Usage

Get document

```bash
npx qifi --help
```

Stream file

```bash
npx qifi ./file.txt
```

Stream file with custom chunk size

```bash
npx qifi <file> [options]
npx qifi -ICS=1000 ./file.txt
```

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.

## Demo

![Demo](../../public/qifi-cli-demo.jpg)
Binary file added public/qifi-cli-demo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit d7aa213

Please sign in to comment.