Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add user guide #421

Merged
merged 2 commits into from
Mar 22, 2022
Merged

chore: add user guide #421

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b796916
chore: add user guide
Eomm Mar 20, 2022
6aa34cb
fix: remove duplicated line
Eomm Mar 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,31 @@ The figma designs can be found [here](https://www.figma.com/file/xsPf6IIM9AevLN5
## Sequence diagram

[![](docs/images/architecture.png)](https://docs.google.com/presentation/d/16038cTBefSKQezJk0IZKNXnSqaG2PnU07Sb2_qIkNe8/edit?usp=sharing)

## User guide

The first step to use the `optic-expo` application is adding a Secret. You can add it by scanning a QR code provided by the OTP Issuer or by inputing it manually.

An example adding an NPM user secret:

![image](https://user-images.githubusercontent.com/11404065/159178304-09a9fa80-a73c-433a-9a29-b6a48aa6af7a.png)

You will see your secret added to the application home page:

![image](https://user-images.githubusercontent.com/11404065/159178421-25e1f0c0-46b5-4c4a-8005-39a5fa5c4fd8.png)

Finally, you need to generate your `optic-token`s by adding a new token:

![image](https://user-images.githubusercontent.com/11404065/159178473-f533f308-e1a6-4240-9ad5-ce8680be0ebd.png)

You can save this token to any system that need to sent to you a notification.
The notification will ask you to approve or deny the system's read to your Secret's OTP.

As you can see by the home page layout, you can generate many tokens to read the same Secret's OTP:

![image](https://user-images.githubusercontent.com/11404065/159178635-418e231c-aa9c-4828-bb41-6f68cfb18059.png)

By doing so, you will be able to understand who is the caller that want to read your OTP.


The first step to use the `optic-expo` application is adding a Secret. You can add it by scanning a QR code provided by the OTP Issuer or by inputing it manually.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this seems to be a copy of the first line. remove

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done