Browse Source

update readme

next
Weilbyte 2 years ago
parent
commit
7f720e6944
No known key found for this signature in database GPG Key ID: E1EB2BFCF73B5B9F
  1. 14
      README.md

14
README.md

@ -10,7 +10,7 @@
The theme now runs its own JavaScript code which patches the colors for certain components (and charts). This approach is much better, and safer than what was used previously. The theme now runs its own JavaScript code which patches the colors for certain components (and charts). This approach is much better, and safer than what was used previously.
## Installation ## Installation
The installation is done via the CLI utility. Run the following commands on the PVE node serving the Web UI: The installation is done via the CLI utility. Run the following commands on the PVE node serving the Web UI: Clearing browser cache is necessary to see the changes.
``` ```
~# wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh ~# wget https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh
@ -21,9 +21,10 @@ Or this oneliner
bash <(curl -s https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh ) install bash <(curl -s https://raw.githubusercontent.com/Weilbyte/PVEDiscordDark/master/PVEDiscordDark.sh ) install
``` ```
Note that you will need to run the install command every time `pve-manager` is updated (i.e. after every Proxmox update)
## Uninstallation ## Uninstallation
To uninstall the theme, simply run the utility with the `uninstall` command. To uninstall the theme, simply run the utility with the `uninstall` command. Clearing browser cache is necessary to see the changes.
## Installer & Security ## Installer & Security
The new installer relies on the `/meta/supported` and `/meta/imagelist` files being present in the repository. It also includes a silent mode. Run `bash PVEDiscordDark.sh -h` for usage instructions. The new installer relies on the `/meta/supported` and `/meta/imagelist` files being present in the repository. It also includes a silent mode. Run `bash PVEDiscordDark.sh -h` for usage instructions.
@ -39,7 +40,12 @@ The `offline` folder must have the following files: `meta/[imagelist, supported]
You can find a zip containing the installer and offline folder under the artifact section of the GitHub Actions under this repository or as an asset attached to releases. You can find a zip containing the installer and offline folder under the artifact section of the GitHub Actions under this repository or as an asset attached to releases.
## Notes ## Contributors
Thanks to [jonasled](https://github.com/jonasled) for helping out with the old version, and thanks to [SmallEngineMechanic](https://github.com/smallenginemechanic) for catching bugs for the rewrite! Thanks to everybody who contributed to this project, and additional thanks to [Crinisus](https://github.com/crinisus) for catching bugs for the rewrite!
<a href="https://github.com/weilbyte/pvediscorddark/graphs/contributors">
<img src="https://contrib.rocks/image?repo=weilbyte/pvediscorddark" />
</a>
*Awoo'ing on this repo is encouraged.* *Awoo'ing on this repo is encouraged.*

Loading…
Cancel
Save