diff --git a/README.md b/README.md index 1b870a9..6439edf 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Nextcloud Themer -An application for theming a Nextcloud instance. Made for next.abtmtr.link to make the instance more interesting than just "Nextcloud". +An application for theming a Nextcloud instance. Made for next.abtmtr.link to make the instance more interesting-looking than just saying "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 +To use this application, follow the setup instructions in `/example/README.md`, then run `npm run dev`. Alternatively, you can run it in a cron job in order to create a shuffling effect on your instance. + +For next.abtmtr.link, this script is run every hour on the dot. \ No newline at end of file diff --git a/example/.env b/example/.env index 9217143..fc3c3b8 100644 --- a/example/.env +++ b/example/.env @@ -1,3 +1,6 @@ +# The URL of your Nextcloud instance. NEXTCLOUD_INSTANCE=nextcloud.cool +# The username of the admin user you will use to change the theme. NEXTCLOUD_LOGIN=myname +# An app password generated by Nextcloud. DO NOT USE YOUR ACCOUNT PASSWORD! NEXTCLOUD_PASSWORD=app-password-please \ No newline at end of file diff --git a/example/README.md b/example/README.md index 47aac9e..6764f99 100644 --- a/example/README.md +++ b/example/README.md @@ -13,4 +13,8 @@ background.png -- "Saved file" name - usually "background", then the extension o 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 +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. + +You can copy the .txt to create as many themes as you desire. Make sure they have identifiable names. + +Once you are done, the application should see the `/themes/` folder and work well. \ No newline at end of file