From 9aaa84bfae57612b8b85dcb2e0aa2682bab6e377 Mon Sep 17 00:00:00 2001 From: Jeremy Kahn Date: Mon, 10 Jun 2024 08:35:16 -0500 Subject: [PATCH] docs(readme): explain theme customization --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cbc25fc..11b17e8 100644 --- a/README.md +++ b/README.md @@ -85,7 +85,7 @@ If you don't agree with the direction of the project, you are welcome to fork Ch ### 🏗️ Support and custom development -I'm willing to do paid installations and customizations of Chitchatter for your needs. If you'd like to contract me to make a version of Chitchatter that is custom built for you, please email me at jeremyckahn@gmail.com and let me know what you have in mind to get started. +I'm willing to do paid installations and customizations of Chitchatter for your needs. If you'd like to contract me to make a version of Chitchatter that is custom built for you, please email me at me@jeremyckahn.com and let me know what you have in mind to get started. --- @@ -231,6 +231,10 @@ Build the app with `npm run build`, and then serve the `dist` directory. Any sta Explore the files in `src/config` to modify pairing and relay server configuration. +#### Theme customization + +Chitchatter utilizes the [MUI component library](https://mui.com/) which is [themeable](https://mui.com/material-ui/customization/theming/). You can customize Chitchatter's look and feel by modifying [the shell theme definition](https://github.com/jeremyckahn/chitchatter/blob/dc78137702bb9d6bf1be289e469e080cd7d5dc8b/src/components/Shell/useShellTheme.ts#L11-L18). + ### Troubleshooting If you run into any issues with a custom Chitchatter installation, first ensure that you are using [the latest version of the code](https://github.com/jeremyckahn/chitchatter/tree/main). If you are hosting your installation with GitHub Pages, sync your `main` branch and _not_ your `gh-pages` branch. Updating your `main` branch will trigger a proper rebuild of your `gh-pages` branch.