yolokube/dashboard
yolokube/dashboard
2
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages 1 Wiki Activity

Update README.md

Browse source
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
1 changed files with 52 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
README.md
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:
@ -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. To add an application, append the following to applications.json or simply edit one of the examples given.
``` ```
{ {
"name": "[Name of the Application]", "name": "[Name of the Application]",
"displayURL": "[URL you want to show]", "displayURL": "[URL you want to show]",
"URL": "[URL to redirect to]", "URL": "[URL to redirect to]",
"icon": "[Icon code]" "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. 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. To add an bookmark, append the following to bookmarks.json or simply edit one of the examples given.
``` ```
{ {
"name": "[Category name]", "name": "[Category name]",
"items": [ "items": [
{ {
"name": "[Bookmark name]", "name": "[Bookmark name]",
"url": "[URL to redirect to]" "url": "[URL to redirect to]"
}, },
{ {
"name": "[Bookmark name]", "name": "[Bookmark name]",
"url": "[URL to redirect to]" "url": "[URL to redirect to]"
}, },
{ {
"name": "[Bookmark name]", "name": "[Bookmark name]",
"url": "[URL to redirect to]" "url": "[URL to redirect to]"
} }
... ...
] ]
}, },
...
``` ```
### Theming: ### 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: 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]", "label": "[Theme Name]",
"value": [Number of the theme], "value": [Number of the theme],
"mainColor": "[Main Color as 6-character hex code]", "mainColor": "[Main Color as 6-character hex code]",
"accentColor": "[Accent Color as 6-character hex code]", "accentColor": "[Accent Color as 6-character hex code]",
"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]"
},
``` ```