Skip to content

Commit

Permalink
Moving the documentation to the new website (#1200)
Browse files Browse the repository at this point in the history
Co-authored-by: James Falade <[email protected]>
  • Loading branch information
alcidesqueiroz and jamesthedove authored Aug 7, 2023
1 parent b184518 commit f8f3bc3
Showing 1 changed file with 6 additions and 30 deletions.
36 changes: 6 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@
<img alt='Download on the App Store' src='https://user-images.githubusercontent.com/84892/191009257-86f3b83e-b2d9-4252-ac05-98732328df2f.png' style="height:40px" />
</a>

## Documentation

The Optic documentation is available [on the website](https://optic.nearform.com/)

To get started, visit the [Getting Started](https://optic.nearform.com/getting-started) page for a brief overview.

## Requirements

- Node LTS
Expand Down Expand Up @@ -84,36 +90,6 @@ The figma designs can be found [here](<https://www.figma.com/file/xsPf6IIM9AevLN

[![](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 wants to read your OTP.

Few notes on the NPM secret:

- the NPM secret (QR or the textual code) is the one that you get, when you enable 2FA in your [npm](https://www.npmjs.com/) profile
- if you already have 2FA activated (with a different authenticatior app e.g. Google Authenticator) and you need to get the secret, the easiest way is to get is to open the authenticator app you were using previously and get the QR code from that app and scan it with Optic Expo

## Store release Guide

The Android app is published to the Play Store once the release workflow is run.
Expand Down

0 comments on commit f8f3bc3

Please sign in to comment.