From 136a0ce775d7afe48adc32246291a2244d1cc2a3 Mon Sep 17 00:00:00 2001
From: Curtis <curtis.rock@wirelessmessaging.com>
Date: Fri, 1 May 2020 21:44:28 +0000
Subject: [PATCH] Update customization.md

---
 docs/customization.md | 45 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 44 insertions(+), 1 deletion(-)

diff --git a/docs/customization.md b/docs/customization.md
index ce1fe72c3..41154ce66 100644
--- a/docs/customization.md
+++ b/docs/customization.md
@@ -1,9 +1,52 @@
 # Customizing Soapbox
 
+First [Install Soapbox](https://soapbox.pub/)
+
 Soapbox supports customization of the user interface, to allow per instance branding and other features.  Current customization features include:
 * Instance name
 * Site logo
+* Promo panel list items, e.g. blog site link
 * Favicon
 * About page
 * Terms of Service page
-* Promo panel list items, e.g. blog site link
\ No newline at end of file
+
+## Instance Name
+Instance name is edited during the Pleroma installation step
+
+## Site Logo and Promo Panel List Items
+The site logo and promo panel list items are customized by copying `soapbox.example.json` in `static/instance` folder to `soapbox.json`
+Re-create the webpack and restart the soapbox-fe service to effect the changes.
+
+An example of the contents of `soapbox.example.json`:
+```
+{
+  "logo": "https://media.gleasonator.com/site_uploads/files/000/000/002/original/logo.svg",
+  "promoPanel": {
+    "items": [{
+      "icon": "area-chart",
+      "text": "Our Site stats",
+      "url": "https://fediverse.network/example.com"
+    }, {
+      "icon": "comment-o",
+      "text": "Our Site blog",
+      "url": "https://blog.example.com"
+    }]
+  },
+  "extensions": {
+    "patron": false
+  },
+  "defaultSettings": {
+    "autoPlayGif": false,
+    "theme": "lime"
+  }
+}
+```
+
+## Favicon
+The favicon is customized by dropping a favicon.png file into the `/static` folder. 
+Re-create the webpack and restart the soapbox-fe service to effect the changes.
+
+## About Page and Terms of Service Page
+The About page is customized by ensuring that the `static/instance/about` folder exists and dropping an `index.html` file into it.
+The Terms of Service page is customized by dropping a `tos.html` file into the `static/instance/about` folder.
+Re-create the webpack and restart the soapbox-fe service to effect the changes.