aboutsummaryrefslogtreecommitdiff
path: root/display_lib/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'display_lib/README.md')
-rw-r--r--display_lib/README.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/display_lib/README.md b/display_lib/README.md
new file mode 100644
index 0000000..7ca97b2
--- /dev/null
+++ b/display_lib/README.md
@@ -0,0 +1,11 @@
+# Dislpay Lib
+
+This library's purpose is to ease creation of wallmounted nodes with a display on front side. For example, signs and clocks. Display can be dynamic and/or different for each node instance.
+
+**Limitations**: This lib uses entities to draw display. This means display has to be vertical. So display nodes are only wallmounted vertically.
+
+**Dependancies**:default
+
+**License**: WTFPL
+
+**API**: See API.md document please.