From c4ac0b6a7a9e0d47366370bfc17cb409bac27b01 Mon Sep 17 00:00:00 2001
From: minie4 <minie4@gmx.de>
Date: Wed, 27 Dec 2023 16:13:03 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20README?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..01bedb5
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# ItslearningDL.go
+
+This Application downloads all file resources that a student has access to from the [Itslearning](https://itslearning.com/global/) learning platform, and stores them on the local disk, retaining the original file structure.
+
+## Setup
+
+To build this project into an executable binary, make sure you have Golang installed and run
+
+```
+go build
+```
+
+Then create a `.env` file in the same directory as the binary and set your itslearning credentials
+
+```
+# Your itslearning username
+ITSLEARNING_USERNAME=
+# Your itslearning password
+ITSLEARNING_PASSWORD=
+# The itslearning instance to use
+# ex. https://berlin.itslearning.com
+ITSLEARNING_INSTANCE=
+```
+
+And run the applcation by executing the binary
+
+```
+./itslearningdl
+```
+
+If everything was successful, the program will now create an `out` folder and save all downloaded files into it.