Skip to content

Commit

Permalink
docs: outdated information in cli example (#35)
Browse files Browse the repository at this point in the history
* Fix script

* Adjust readme.

* Fix script

* Update README.md

* Remove optional step.
  • Loading branch information
lukasbicus authored Jul 21, 2024
1 parent ca17224 commit 4a0f060
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions docs/examples/cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### How to run bysquare in the terminal

To encode data from example.json and print it as a string in the terminal, use the following command:

```bash
npx bysquare --encode example.json
```

Make sure that path to example.json is correct and contains the data you want to encode.

If you want to display the encoded data as a QR code in the terminal, you can pipe the output of the encode command to qrcode-terminal:
```bash
npx bysquare --encode example.json | npx qrcode-terminal
```
Binary file removed docs/examples/cli/example_qrcode_terminal.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/examples/cli/example_qrcode_terminal.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

cd "$(dirname $0)" || exit 1

bysquare example.json | npx qrcode-terminal
bysquare --encode example.json | npx qrcode-terminal

0 comments on commit 4a0f060

Please sign in to comment.