diff --git a/README.md b/README.md new file mode 100644 index 0000000..35cf05e --- /dev/null +++ b/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**
+All that matters, at one glance!
+*Date and Time – Upcoming Events – Public Announcement Space – News Ticker – Picture Showcase* + +- **Easy Install**
+Set up a RaspberryPi, run the [installer script](TODO), done! + +- **DAV Server Interface**
+Update your content anytime, from anywhere! +Basic [Markdown](https://www.markdownguide.org/) is enough!
+Already have a [Nextcloud](https://nextcloud.com/) instance? +OVDashboard will take it from there! + +- **Customizable – Yet Always Recognizable**
+Change the Logo – Put your own Title – Publish Pictures – Create Event Lists – Customize the News Ticker Appearance – Adjust Item Rotation Speed + +- **Responsive Design**
+Clearly, this is made for the big screen – but OVDashboard also shines in your visitors' mobile browsers! + +- **Locale Aware**
+No static text anywhere – formats are everything generated using [Luxon](https://moment.github.io/luxon/#/), which respects your browsers' settings! + +- **Hackable**
+The Dashboard UI is created using [Vue](https://vuejs.org/) and the [Vuetify](https://vuetifyjs.com/) UI library.
+*Like this layout, but want it for something completely different? Fork me!* diff --git a/doc/ovdashboard_de.jpg b/doc/ovdashboard_de.jpg new file mode 100644 index 0000000..a9092e1 Binary files /dev/null and b/doc/ovdashboard_de.jpg differ diff --git a/doc/ovdashboard_en.jpg b/doc/ovdashboard_en.jpg new file mode 100644 index 0000000..75a06a0 Binary files /dev/null and b/doc/ovdashboard_en.jpg differ