From b7e8924ac2a0cc3f0ebdf73233939fa0060e5ae8 Mon Sep 17 00:00:00 2001
From: Robert Goldmann <deadlocker@gmx.de>
Date: Mon, 28 Dec 2020 19:26:31 +0100
Subject: [PATCH] Add README.md

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fd0c2f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# DashboardLeaf
+
+Flask server for displaying multiple dashboards with custom tiles that refresh periodically.
+
+## Page
+
+Holds multiple tiles and displays them in a grid. On mobile devices in portrait orientation the grid will be displayed as a single column.
+
+## Tile
+
+A tile is displayed on a page and shows arbitrary information. It is possible to create custom tiles.
+
+### Tile properties
+- `x` - horizontal position in the grid, starting by 0 (**Note:** Positions should not be assigned more than once!)
+- `y` - vertical position in the grid, starting by 0 (**Note:** Positions should not be assigned more than once!)
+- `width` - ???
+
+
+### Create a custom tile
+
+1. Create a new tile inside `folder_name` using the following template:
-- 
GitLab