aboutsummaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
Diffstat (limited to 'src')
-rw-r--r--src/keycloak-theme/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/src/keycloak-theme/README.md b/src/keycloak-theme/README.md
new file mode 100644
index 0000000..0920d0b
--- /dev/null
+++ b/src/keycloak-theme/README.md
@@ -0,0 +1,29 @@
+Your theme source files should be located in a keycloak-theme directory somewhere in your src directory OR at the root of your directory.
+Acceptable directory strucuture:
+
+```txt
+src/
+ keycloak-theme/
+ login/
+ account/
+ email/
+
+===OR===
+
+src/
+ foo/
+ bar/
+ keycloak-theme/
+ login/
+ account/
+ email/
+
+===OR===
+
+src/
+ login/
+ account/
+ email/
+```
+
+You don't need to have all three variant of the theme. If you only need the login theme for example you can have only the login directory.