aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThorsten Ortlepp <post@ortlepp.eu>2020-03-29 13:59:25 +0200
committerThorsten Ortlepp <post@ortlepp.eu>2020-03-29 13:59:25 +0200
commitcd4f6f88a2c45ba0cce1f0e21c00e0a4235261ee (patch)
tree64ad5190a4feba5c3f124f8cf794592155384d5e
parent2f6c5d1b7836442514459ce167908951dab6f6c5 (diff)
downloadsimple-dash-fork-cd4f6f88a2c45ba0cce1f0e21c00e0a4235261ee.zip
Updated README
-rw-r--r--README29
-rw-r--r--README.md23
2 files changed, 29 insertions, 23 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
diff --git a/README.md b/README.md
deleted file mode 100644
index 5d5dac0..0000000
--- a/README.md
+++ /dev/null
@@ -1,23 +0,0 @@
-[![Mentioned in Awesome-Selfhosted](https://awesome.re/mentioned-badge.svg)](https://github.com/Kickball/awesome-selfhosted#personal-dashboards)
-# simple-dash
-
-Try the Demo here: http://simple-dash-demo.bplaced.net/
-
-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 FontAwesome libary.
-simple-dash is made to be as simple and minimalistic as possible. (The goal was to create a dashboard even my mom could use!) :)
-Based on: https://github.com/thetomester13/homepage
-
-This project uses:
-- Font Awesome
-- Trianglify
-
-## Screenshots
-![Homepage Desktop](example_img/homepage-desktop.jpg?raw=true)
-![Homepage Mobile](example_img/homepage-mobile.jpg?raw=true)
-
-## To Use
-Copy the config.sample.json file and rename to config.json. Be sure to update the fields as you see appropriate.
-
-## Configure Homepage
-- 'items' => The menu will scale to the amount of items you want to display. Insert any link you'd like, or {{cur}} for the current URL of the page. Choose icons from [Font Awesome](http://fontawesome.io/icons/)