From ad2e2698cb3d716cdd177167f29882417224ac77 Mon Sep 17 00:00:00 2001
From: Bastian Meissner <meissner.bastian@gmail.com>
Date: Wed, 20 May 2020 17:03:19 +0200
Subject: [PATCH] Update README.md

---
 README.md | 84 ++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 52 insertions(+), 32 deletions(-)

diff --git a/README.md b/README.md
index f2936b4..6d3fcc3 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,14 @@
 
 Dashboard is just that - a dashboard. It's inspired by [SUI](https://github.com/jeroenpardon/sui) and has all the same features as SUI.
 
+## Features
+
+So what makes this thing better than SUI?
+
+- "Display URL" functionality, in case the URL you want to show is different than the URL you want to be redirected to
+- Theming through JSON
+- Search providers customizable through JSON (SUI has them both in a JSON and hardcoded)
+
 ## Installation
 Getting Dashboard to run is fairly simple:
 
@@ -27,13 +35,13 @@ Dashboard is designed to be customizable. Everything is handled using four .json
 To add an application, append the following to applications.json or simply edit one of the examples given.
 
 ```
-    {
-	    "name": "[Name of the Application]",
-	    "displayURL": "[URL you want to show]",
-	    "URL": "[URL to redirect to]",
-	    "icon": "[Icon code]"
-    }
-    ...
+{
+	"name": "[Name of the Application]",
+	"displayURL": "[URL you want to show]",
+	"URL": "[URL to redirect to]",
+	"icon": "[Icon code]"
+}
+...
 ```
 
    To find icons, simply go to the [Material Design Icon Library](https://material.io/icons/) and copy one of the codes for an icon there.
@@ -43,35 +51,47 @@ To add an application, append the following to applications.json or simply edit
 To add an bookmark, append the following to bookmarks.json or simply edit one of the examples given.
 
 ```
-    {
-	    "name": "[Category name]",
-	    "items": [
-	    {
-		    "name": "[Bookmark name]",
-		    "url": "[URL to redirect to]"
-	    },
-	    {
-		    "name": "[Bookmark name]",
-		    "url": "[URL to redirect to]"
-	    },
-	    {
-		    "name": "[Bookmark name]",
-		    "url": "[URL to redirect to]"
-	    }
-	    ...
-    ]
-    },
+{
+	"name": "[Category name]",
+	"items": [
+		{
+		"name": "[Bookmark name]",
+		"url": "[URL to redirect to]"
+		},
+		{
+		"name": "[Bookmark name]",
+		"url": "[URL to redirect to]"
+		},
+		{
+		"name": "[Bookmark name]",
+		"url": "[URL to redirect to]"
+		}
+		...
+	]
+},
+...
 ```
 
 ### Theming:
 Dashboard also supports themes with the help of a simple JSON-file: themes.json. To add a theme, append the following to themes.json:
 
 ```
-    {
-	    "label": "[Theme Name]",
-	    "value": [Number of the theme],
-	    "mainColor": "[Main Color as 6-character hex code]",
-	    "accentColor": "[Accent Color as 6-character hex code]",
-	    "backgroundColor": "[Background Color as 6-character hex code]"
-    }
+{
+	"label": "[Theme Name]",
+	"value": [Number of the theme],
+	"mainColor": "[Main Color as 6-character hex code]",
+	"accentColor": "[Accent Color as 6-character hex code]",
+	"backgroundColor": "[Background Color as 6-character hex code]"
+}
+```
+
+### Search Providers:
+The searchbar on the top supports shortcuts like "/so", just as SUI does. To add one of your own, simply append the following to search.json
+
+```
+{
+	"name":"[Name of the website]",
+	"url":"[Link that processes searches on that website]",
+	"prefix":"[a custom prefix]"
+},
 ```