diff --git a/README.md b/README.md index 61785a3..4a37920 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,12 @@ pnpm i ## Scrips > All of the current scripts - explained +### Shared +#### Login +* Description: Authenticates the user against the backend while setting the OPENAPI objects properties +* Use-case: Used in all other scripts to reduce code duplication +* Config: Set the env vars +* Run: `node ./src/shared/login.js` ### Scans #### Create fixed scans for group * Description: Creates distance scans for all runners of a team or org