main README

README.md

@@ -0,0 +1,33 @@
+# OVDashboard
+
+A fancy dashboard for use in a [THW](https://en.wikipedia.org/wiki/Technisches_Hilfswerk)-Ortsverband (OV).
+
+![Screenshot](./doc/ovdashboard_en.jpg)
+
+## Key Features
+
+- **Clean Look** <br />
+All that matters, at one glance! <br />
+*Date and Time &ndash; Upcoming Events &ndash; Public Announcement Space &ndash; News Ticker &ndash; Picture Showcase*
+
+- **Easy Install** <br />
+Set up a RaspberryPi, run the [installer script](TODO), done!
+
+- **DAV Server Interface** <br />
+Update your content anytime, from anywhere!
+Basic [Markdown](https://www.markdownguide.org/) is enough! <br />
+Already have a [Nextcloud](https://nextcloud.com/) instance?
+OVDashboard will take it from there!
+
+- **Customizable &ndash; Yet Always Recognizable** <br />
+Change the Logo &ndash; Put your own Title &ndash; Publish Pictures &ndash; Create Event Lists &ndash; Customize the News Ticker Appearance &ndash; Adjust Item Rotation Speed
+
+- **Responsive Design** <br />
+Clearly, this is made for the big screen &ndash; but OVDashboard also shines in your visitors' mobile browsers!
+
+- **Locale Aware** <br />
+No static text anywhere &ndash; formats are everything generated using [Luxon](https://moment.github.io/luxon/#/), which respects your browsers' settings!
+
+- **Hackable** <br />
+The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library. <br />
+*Like this layout, but want it for something completely different? Fork me!*