From d41cf3c907c3525fc778f4b44c3b2ca31dec419c Mon Sep 17 00:00:00 2001
From: David Langley <langley.dave@gmail.com>
Date: Thu, 4 Nov 2021 12:29:49 +0000
Subject: [PATCH] Expand on BuildingSetting description and add changelog

---
 Config/BuildSettings.swift | 6 ++++--
 changelog.d/4981.feature   | 1 +
 2 files changed, 5 insertions(+), 2 deletions(-)
 create mode 100644 changelog.d/4981.feature

diff --git a/Config/BuildSettings.swift b/Config/BuildSettings.swift
index 4daf809ad..d740eb29a 100644
--- a/Config/BuildSettings.swift
+++ b/Config/BuildSettings.swift
@@ -134,12 +134,14 @@ final class BuildSettings: NSObject {
         "matrix.to": ["/"],
         "www.matrix.to": ["/"],
         // Client Permalinks (for use with `BuildSettings.clientPermalinkBaseUrl`)
-//        "clienturl.com": ["/"],
-//        "www.clienturl.com": ["/"],
+//        "example.com": ["/"],
+//        "www.example.com": ["/"],
     ]
     
     // For use in clients that use a custom base url for permalinks rather than matrix.to.
     // This baseURL is used to generate permalinks within the app (E.g. timeline message permalinks).
+    // Optional String that when set is used as permalink base, when nil matrix.to format is used.
+    // Example value would be "https://www.example.com", note there is no trailing '/'.
     static let clientPermalinkBaseUrl: String? = nil
     
     // MARK: - VoIP
diff --git a/changelog.d/4981.feature b/changelog.d/4981.feature
new file mode 100644
index 000000000..2d1a3e79f
--- /dev/null
+++ b/changelog.d/4981.feature
@@ -0,0 +1 @@
+Adds clientPermalinkBaseUrl for a custom permalink base url.