diff --git a/README.md b/README.md new file mode 100644 index 0000000..61785a3 --- /dev/null +++ b/README.md @@ -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` \ No newline at end of file