From 1ee4a3c18faead4435384bc7bbfca9db4b01c766 Mon Sep 17 00:00:00 2001 From: Andrew McGee <45531427+Andrew-McGee@users.noreply.github.com> Date: Sun, 19 Sep 2021 21:21:18 +1000 Subject: [PATCH] Update README Putting some instructions in there. --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 8d598c4..a5b8a62 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,22 @@ # nanodash A static dashboard for self-hosters to launch your admin apps (or any bookmarked sites). + +## Intro +When you don't want to mess around with building project dependencies or lavarel or php or node - you just need a launchpad with that is clean, tidy and extremely mininal. No bloat, no bells or whistles. + +If you don't include thumbnails or backgrounds nanodash boils down to two files. 37 lines of html at 2,111 bytes and 61 lines of css weighing in at 980 bytes. It could be even smaller if you don't need all the default 4x3 tiles. + +## Install & Config +Clone the repo and edit the index.html with your apps, pointing to your links. Source and edit your own logos if required and drop them in the thumbs directory. Drop everything into a directory on your web server. + +Grab a beverage, sit back and take it easy. That's all. + +## Features +There are none. + +## Dependencies +Nope. No JS. No PHP. No NodeJS. Just vanilla html and css. + +## Credits +Thanks [Heimdall](https://github.com/linuxserver/Heimdall) for the inspiration. +I use the same background as Heimdall which is free from [pexels](https://www.pexels.com/).