summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYuval Adam <_@yuv.al>2021-03-01 09:55:09 +0200
committerYuval Adam <_@yuv.al>2021-03-01 09:55:09 +0200
commitd2c9f64e385863506673fe73fcf3fd5ff7746900 (patch)
tree0fa2a9e5193f68919c3216ba70d9fc6fb1db6429 /README.md
parenteb5d270ffc7d28b6bffe4789a8ea421b27be0f25 (diff)
Cleanup some files, run formatting, and update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/README.md b/README.md
index 4c86597..bf68784 100644
--- a/README.md
+++ b/README.md
@@ -10,32 +10,28 @@ A pythonic implementation of the verification process can be found in [`verify.p
### Setup
-Install [`pipenv`](https://pypi.org/project/pipenv/) and execute:
+Install [`pipenv`](https://pipenv.pypa.io/en/latest/) and sync the required dependencies:
+
```bash
-pipenv install
+pipenv sync
```
### Usage
#### Option 1 - from QR code image
+
Save your Green Pass as a `.png` file and execute:
+
```bash
pipenv run python verify.py -i green_pass_image.png
```
#### Option 2 - from QR code decoded textual content
-Decode the QR code payload yourself, put it in a txt file:
-
-*textual_payload.txt*
-```json
-base64EncodedSignature==#{"id":"01/IL/ABCD1234ABCD1234ABCD1234ABCD1234#ABCD1234","et":1,"ct":1,"c":"IL MOH","cn":null,"fn":null,"g":null,"f":null,"gl":null,"fl":null,"idp":null,"idl":null,"b":"0001-01-01","e":"0001-01-01","a":"0001-01-01","p":[{"idl":"012345678","e":"2021-01-01"}]}
-```
-
-And then execute:
+Decode the QR code payload yourself, put it in a txt file and then execute:
```bash
-pipenv run python verify.py -t textual_payload.txt
+pipenv run python verify.py -t green_pass_payload.txt
```
### Output example