aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README29
1 files changed, 29 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ada808c
--- /dev/null
+++ b/README
@@ -0,0 +1,29 @@
+simple-dash
+-----------
+
+A simple, fully responsive dashboard to forward to the services of your choice! Ideal for desktop and mobile usage!
+Add all of your services, whether you host them yourself or not and display them as neat icons from the Font Awesome libary.
+simple-dash is made to be as simple and minimalistic as possible.
+
+Try the demo here: https://demo.ortlepp.eu/simple-dash-fork/
+
+
+/!\ This repository is a fork and contains some customisations
+ The original code is here: https://github.com/lil5/simple-dash
+
+
+
+Usage
+-----
+
+Open index.html in your favorite text editor.
+Set the title of the dashboard in <title>.
+Add links below <div id="itemlist">, choose icons from Font Awesome.
+
+
+
+This project uses
+-----------------
+
+- Font Awesome - https://fontawesome.com/
+- Trianglify - https://github.com/qrohlf/trianglify