Added readme

This commit is contained in:
Nicolai Ort 2023-04-25 20:53:49 +02:00
parent 5e2e633b81
commit 5dd86a81aa
Signed by: niggl
GPG Key ID: 13AFA55AF62F269F
1 changed files with 17 additions and 0 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# @lfk/scripts
Some fun little scripts to automate tasks regarding the LfK Läufersystem.
## Setup 🛠️
```bash
pnpm i
```
## Scrips
> All of the current scripts - explained
### Scans
#### Create fixed scans for group
* Description: Creates distance scans for all runners of a team or org
* Use-case: Schools that get their walk to the event location added to their total distance
* Config: Just set the org id or team id in the first lines of the script
* Run: `node ./src/scans/createFixedScansForGroup.js`