Create README.md

franknitschke · Jul 22, 2023 · 5c7542c · 5c7542c
1 parent 41b329a
commit 5c7542c
Showing 1 changed file with 31 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# Referee software for powerlifting competitions
+
+## ‼️Before use
+
+**The software is developed for use in a secure private network only (for security reasons). It is not recommended to use it on a public server!
+Please change all default passwords and tokens immediately after installation.**
+
+# Installation
+
+1. Install Node.js >= 18.xx
+2. Clone git repo
+3. `cd yourFolder/server`
+4. `npm i`
+
+# Installation on RaspberryPi
+
+🚧 Coming soon
+
+## Start
+
+1. `cd yourFolder/server`
+2. `npm start`
+
+## Default credentials
+
+For /settings
+
+User: admin
+Pass: admin
+
+‼️**Please change the passwords and referee tokens**‼️