diff --git a/.gitignore b/.gitignore index 5e435ec..024c2b2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ node_modules/ -themes/ -assets/ -.env +/themes/ +/assets/ +/.env package-lock.json \ No newline at end of file diff --git a/README.md b/README.md index 91c3845..1b870a9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ # Nextcloud Themer -An application for theming a Nextcloud instance. \ No newline at end of file +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. \ No newline at end of file diff --git a/example/.env b/example/.env new file mode 100644 index 0000000..9217143 --- /dev/null +++ b/example/.env @@ -0,0 +1,3 @@ +NEXTCLOUD_INSTANCE=nextcloud.cool +NEXTCLOUD_LOGIN=myname +NEXTCLOUD_PASSWORD=app-password-please \ No newline at end of file diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000..3cd7787 --- /dev/null +++ b/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. \ No newline at end of file diff --git a/example/assets/doohickey.png b/example/assets/doohickey.png new file mode 100644 index 0000000..bd9fb4f Binary files /dev/null and b/example/assets/doohickey.png differ diff --git a/example/themes/doohickey.txt b/example/themes/doohickey.txt new file mode 100644 index 0000000..3c3ce4d --- /dev/null +++ b/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 \ No newline at end of file