Added readme

This commit is contained in:
Nicolai Ort 2023-04-25 20:55:24 +02:00
parent 5dd86a81aa
commit 81eb83547e
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
1 changed files with 6 additions and 0 deletions

View File

@ -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