-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: outdated information in cli example (#35)
* Fix script * Adjust readme. * Fix script * Update README.md * Remove optional step.
- Loading branch information
1 parent
ca17224
commit 4a0f060
Showing
3 changed files
with
15 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters