Update README.md

This commit is contained in:
Bastian Meissner 2020-05-20 17:03:19 +02:00 committed by GitHub
parent 2574115f93
commit ad2e2698cb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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. 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 ## Installation
Getting Dashboard to run is fairly simple: Getting Dashboard to run is fairly simple:
@ -61,6 +69,7 @@ To add an bookmark, append the following to bookmarks.json or simply edit one of
... ...
] ]
}, },
...
``` ```
### Theming: ### Theming:
@ -75,3 +84,14 @@ Dashboard also supports themes with the help of a simple JSON-file: themes.json.
"backgroundColor": "[Background 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]"
},
```