Example folder

.gitignore

@@ -1,5 +1,5 @@
 node_modules/
-themes/
-assets/
-.env
+/themes/
+/assets/
+/.env
 package-lock.json

README.md

@@ -1,3 +1,5 @@
 # Nextcloud Themer
 
-An application for theming a Nextcloud instance.
+An application for theming a Nextcloud instance. Made for next.abtmtr.link to make the instance more interesting than just "Nextcloud".
+
+To use this application, just run "npm run dev". Alternatively, you can run it in a cron job in order to create a shuffling effect on your instance.

example/.env

@@ -0,0 +1,3 @@
+NEXTCLOUD_INSTANCE=nextcloud.cool
+NEXTCLOUD_LOGIN=myname
+NEXTCLOUD_PASSWORD=app-password-please

example/README.md

@@ -0,0 +1,16 @@
+# Example
+
+Move the contents of this "example" folder into the project's root directory in order to add themes.
+
+Asset images can be held anywhere, but it's best to hold it in the `/assets/` folder for cleanliness.
+
+## Theme example
+```
+Doohickey Corporation -- Instance name
+a company that specializes in the creation of technology -- Instance slogan
+/assets/doohickey.png -- Image asset - path from root of project
+background.png -- "Saved file" name - usually "background" then the extension of the image
+image/png -- MIME type - usually "image/png" or "image/jpeg"
+#FFFF00 -- Accent color - in hex
+```
+If you are on Windows or any system that uses `CR LF`, make sure you are saving the file with `LF` and not `CR LF`. Text editors like Notepad++ and Visual Studio Code should support changing this.

example/themes/doohickey.txt

@@ -0,0 +1,6 @@
+Doohickey Corporation
+a company that specializes in the creation of technology
+/assets/doohickey.png
+background.png
+image/png
+#FFFF00