From efe9f15f58c868aaed753787277e67a7ba1fc0a0 Mon Sep 17 00:00:00 2001
From: Justus Dieckmann <justusdieckmann@wwu.de>
Date: Mon, 13 Apr 2020 18:18:15 +0200
Subject: [PATCH] Add Readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf4d72b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# customfield_semester
+
+Adds a Semester customfield type to moodle.
+
+Choosable options for a semester customfield are a  list of semesters and the `"semesterindependent"` option.
+
+Exactly which semesters are choosable are defined by these three options:
+
+- The year, in which the list of semesters begins.
+    - Default value: `2007`
+- An amount of months, that affects how many future semesters are added as options.
+For example, if you choose 9 months, all semesters that begin in the next 9 months (from whenever the semester menu is being viewed) are selectable additionally to all past ones.
+    - Default value: `6`
+- An amount of months, that affects which semester is selected as default.
+For example, if you choose 3 months, the default selection is the semester that will be in progress 3 months from whenever the semester menu is being viewed.
+    - Default value: `3`
\ No newline at end of file
-- 
GitLab