summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBen Busby <contact@benbusby.com>2025-01-27 12:53:57 -0700
committerBen Busby <contact@benbusby.com>2025-01-27 12:53:57 -0700
commite0044ed885591c2d8243fe2624a42d4243ca1fad (patch)
tree88ef57d07bf3a07acff576ea0ac7a325cc5e506e /README.md
parent56a4202827b3003407a8e1b863c09793af08ea7f (diff)
downloadfarside-e0044ed885591c2d8243fe2624a42d4243ca1fad.tar.gz
Update readme [skip ci]
Adds search integration docs to readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2eb2987..a19751e 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,9 @@ Contents
4. [Cloudflare](#regarding-cloudflare)
5. [Development](#development)
1. [Environment Variables](#environment-variables)
+6. [Search Integration](#search-integration)
+ 1. [Kagi](#kagi)
+ 2. [Whoogle Search](#whoogle-search)
## About
@@ -194,3 +197,26 @@ goes against what Farside is trying to solve. Use at your own discretion.
</tr>
</table>
+## Search Integration
+
+### Kagi
+
+On the settings page, go to `Search > Advanced > Open Redirects` and setup your redirects.
+
+With the exception of BreezeWiki, most redirect rules can just extract the path of the
+link you're visiting and append them to whichever Farside redirect you want to use.
+
+For example:
+
+##### Medium -> Scribe
+
+`^https://medium.com/(.*)|https://farside.link/scribe/$1`
+
+##### Fandom -> BreezeWiki
+
+`^https://([^/]+).fandom.com/(.*)|https://farside.link/breezewiki/$1/$2`
+
+### Whoogle Search
+
+Whoogle automatically routes eligible links through Farside when the `Replace
+Social Media Links` option in the home page settings menu is enabled.