Documentation on configuration. #1

README.md

@@ -5,6 +5,8 @@
 
 - [Engine Clock](#engine-clock)
     - [Customization](#customization)
+        - [Configure using a `dotenv` file](#configure-using-a-dotenv-file)
+        - [Configure the Web Component](#configure-the-web-component)
     - [Build and deploy for production](#build-and-deploy-for-production)
     - [Development](#development)
         - [Requirements](#requirements)
@@ -17,14 +19,57 @@ Aura Engine Clock is a web application for displaying the studio clock of the [A
 
 ## Customization
 
+The project allows to be configured in two ways:
+
+- During build-time using `.env` configuration
+- During run-time by modifying the attributes of the Web Component.
+
+### Configure using a `dotenv` file
+
+Copy `config/default-sample.env` to `.env` in the project root and modify the given properties.
+In order to apply these configuration changes a build is required.
+
+```ini
+NAME="Studio Clock"
+LOGO="https://gitlab.servus.at/aura/meta/-/raw/master/images/aura-logo.png"
+LOGO_SIZE="100px" 
+API_URL="http://localhost:8008/api/v1/"
+UNKNOWN_TITLE="Unknown Title"
+NO_CURRENT_SCHEDULE="Right now, there's no show playing"
+NO_NEXT_SCHEDULE="Nothing scheduled next"
+PLAY_OFFSET=3
+CSS=""
+```
+
+### Configure the Web Component
+
+Modify the `index.html` created by the build process (see next step). Using this approach you are
+able to override any configurations already performed during the build.
+
+```html
+<aura-clock
+    name="Orange O94"
+    logo="https://o94.at/themes/custom/radio_orange/logo1.png"
+    logosize="180px" 
+    api="http://localhost:8008/api/v1/"
+    css="/sample/o94.css"
+    unknowntitle="Unbekannter Titel"
+    nocurrentschedule="Derzeit keine Sendung"
+    nonextschedule="Keine weiteren Sendungen"
+    playoffset=3>
+</aura-clock>
+```
+
 ## Build and deploy for production
 
-To create an optimised version of the app run
+Build the bundle for deployment
 
 ```bash
-npm run build
+./run.sh build
 ```
 
+Copy the bundle files in `public/build/` to some web server.
+
 ## Development
 
 ### Requirements