Add README

Signed-off-by: Knut Ahlers <knut@ahlers.me>

README.md

@@ -0,0 +1,32 @@
+# Luzifer / publish-vod
+
+Imagine having multiple archives for your VoDs. Imagine uploading the VoD to each of them manually. Eventually you write a script doing the legwork but that script only uploads sequentially and you always need to edit the script.
+
+Or you create a config for this tool and start one command which then concurrently uploads the VoD to all the configured targets.
+
+## Config
+
+```yaml
+---
+
+uploaders:
+
+  - name: Example SFTP
+    type: sftp
+    settings:
+      host: hostname:port
+      path: /where/to/put/the/file
+      user: someoneimportant
+
+  - name: Example Youtube
+    type: youtube
+    settings:
+      channel: the ID of your channel found in its link
+      description: |
+        What to put in the description field
+      vaultKey: secret/youtube-creds
+
+...
+```
+
+The `youtube` uploader relies on [Vault](https://www.vaultproject.io/) to store the oauth-token and the client credentials. Create a Google Cloud Platform project, enable the Youtube Data API, create a new application ("OAuth 2.0 Client IDs") with Type "Desktop App", put the client ID and client secret into the keys `clientId` and `clientSecret` in that Vault key. Run `publish-vod --validate-only` to authorize the application. This will automatically store the token into the Vault key.