diff --git a/README.md b/README.md
index 6673944d..4aa40f1e 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,13 @@
Dashy
A static site linking to all running services for networking, management and monitoring
+[](https://www.codacy.com/gh/Lissy93/dashy/dashboard)
+
+
+
+
+
+
@@ -56,6 +63,8 @@ Also within `./public` you'll find normal website assets, including `favicon.ico
All app config is specified in [`/public/conf.yml`](https://github.com/Lissy93/dashy/blob/master/public/conf.yml) (in [YAML Format](https://yaml.org/)).
All fields are optional, unless otherwise stated.
+**Examples**: [Example Config 1](https://listed.to/p/HA5Hq5PHFO) ┆ [Example Config 2](https://listed.to/p/a1gvTPGTEz) ┆ [Example Config 2](https://listed.to/p/a1gvTPGTEz)
+
**`pageInfo`**
- `title` - String: The page title and heading
- `description` - String: Short description visible under the heading
@@ -127,6 +136,12 @@ appConfig:
---
## Notes
+### Roadmap 🛣
+
+- [ ] Allow users to import / export configuration through the UI
+- [ ] Improve deployment process (with a one-liner Docker run command)
+- [ ] Add support for custom widgets
+- [ ] Convert JavaScript to TypeScript
### Credits 🏆
@@ -135,6 +150,8 @@ The app makes use of the following components, kudos to their respective authors
- [`vue-js-modal`](https://github.com/euvl/vue-js-modal) - Modal component by @euvl
- [`v-tooltip`](https://github.com/Akryum/v-tooltip) - Tooltip component by @Akryum
+And the app itself is built with [Vue.js](https://github.com/vuejs/vue) 
+
### License 📜
```
diff --git a/package.json b/package.json
index d4cdae4a..414174c6 100644
--- a/package.json
+++ b/package.json
@@ -45,7 +45,8 @@
],
"rules": {
"import/no-unresolved": "off",
- "arrow-parens": 0
+ "arrow-parens": 0,
+ "no-else-return": 0
},
"parserOptions": {
"parser": "babel-eslint"
diff --git a/public/conf.yml b/public/conf.yml
index 851a8af2..f16749d8 100644
--- a/public/conf.yml
+++ b/public/conf.yml
@@ -1,4 +1,26 @@
---
pageInfo:
- title: Dashy
-sections:
\ No newline at end of file
+ title: Getting Started
+ navLinks:
+ - title: Home
+ path: /
+ - title: About
+ path: /about
+ - title: Source Code
+ path: https://github.com/Lissy93/dashy
+appConfig:
+ theme: material-dark
+ fontAwesomeKey: 0821c65656
+sections:
+- name: Dashy
+ items:
+ - title: Source
+ description: Source code and documentation on GitHub
+ icon: fab fa-github
+ url: https://github.com/Lissy93/dashy
+ - title: Issues
+ description: View currently open issues, or raise a new one
+ icon: fas fa-bug
+ url: https://github.com/Lissy93/dashy/issues
+
+
diff --git a/src/components/LinkItems/ItemIcon.vue b/src/components/LinkItems/ItemIcon.vue
index b3d7409c..3b94e160 100644
--- a/src/components/LinkItems/ItemIcon.vue
+++ b/src/components/LinkItems/ItemIcon.vue
@@ -1,6 +1,6 @@
-
-
+
+
-