diff --git a/README.md b/README.md index 5c5d734..2a4d9c3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,10 @@ # riot-web-themes A place to share themes for [Riot Web](https://github.com/vector-im/riot-web). See the [theming documentation](https://github.com/vector-im/riot-web/blob/master/docs/theming.md) for more information on how these work. -You can use these by editing your `config.json` file to include the theme inside of the `settingDefaults` section like this: +There are several different ways to use these. Unfortunately [Riot doesn't yet provide an easy one click way to install themes](https://github.com/vector-im/riot-web/issues/12517). Some options for installing themes include: + +#### If you self host Riot or use Riot Desktop: +You can use these themes by editing your `config.json` file to include the theme inside of the `settingDefaults` section like this: ```json "settingDefaults": { @@ -22,6 +25,17 @@ You can use these by editing your `config.json` file to include the theme inside } ``` +To setup a `config.json` file with Riot Desktop, see https://github.com/vector-im/riot-web/blob/master/docs/config.md#desktop-app-configuration + + +#### If you are a Firefox user +You can install Radical which is Riot web bundled as a Firefox add-on. You can edit the `config.json` file right in the add-on preferences. It works really well, you should check it out. https://addons.mozilla.org/en-US/firefox/addon/radical-web/ + +#### Use my Riot Web instance +Alternatively you can use [my Riot Web instance](https://riot.raim.ist) which has all of these themes preinstalled so there is no configuration required. + + +# Themes ## [ThomCat Black](ThomCat-Black/ThomCat-Black.json)