Add documentation for Atem Service

docs/index.md

@@ -29,6 +29,7 @@ If that's no problem you can head over to the [installation guide](./getting_sta
 -   AutoHotkey
 -   Android (using adb)
 -   Art-Net
+-   Atem
 -   CurseForge
 -   DBus
 -   Discord

docs/samples/atem.md

@@ -0,0 +1,38 @@
+## Using the Atem sample bundle
+
+The Atem sample bundle in `samples/atem` shows how to listen to commands.
+
+### Prerequisites
+
+You will need a working `nodecg-io` installation. If you have non yet take a
+look at [installation guide](../getting_started/install.md). You may need to
+install this bundle, so take a look at the
+[“Try an included sample”](../getting_started/try_example_bundle.md)-Guide. It
+will also tell you how to log in and how to use the GUI.
+
+
+### Configure the Atem sample bundle
+
+1. In NodeCG, create a new atem service instance.
+2. Enter the address and optional a port of the Atem server:
+
+    ```json
+    {
+        "address": "0.0.0.0"
+    }
+    ```
+
+    or
+
+    ```json
+    {
+        "address": "0.0.0.0",
+        "port": 9910
+    }
+    ```
+
+    After entering it, click save.
+
+3. Set the sample's (`atem`) dependency to be the newly created
+   service instance (of type `atem`).
+4. Now all commands sended through the atem protocol should be logged in the console.

docs/services.md

@@ -37,6 +37,15 @@ See the [sample implementation](samples/artnet.md)
 Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.2.0 <br>
 Depends on [artnet-protocol](https://www.npmjs.com/package/artnet-protocol) @ ^0.2.1 <br>
 
+## [nodecg-io-atem](https://github.com/codeoverflow-org/nodecg-io/tree/master/services/nodecg-io-atem)
+
+**Allows you to communicate with atem protocol**
+
+See the [sample implementation](samples/atem.md)
+
+Depends on [nodecg-io-core](https://github.com/codeoverflow-org/nodecg-io/tree/master/nodecg-io-core) @ ^0.2.0 <br>
+Depends on [atem-connection](https://www.npmjs.com/package/atem-connection) @ ^2.3.1 <br>
+
 ## [nodecg-io-curseforge](https://github.com/codeoverflow-org/nodecg-io/tree/master/services/nodecg-io-curseforge)
 
 **A service to communicate with the CurseForge API.**

mkdocs.yml

@@ -52,6 +52,7 @@ nav:
           - Available services: services.md
           - AHK sample: samples/ahk.md
           - Art-Net sample: samples/artnet.md
+          - Atem sample: samples/atem.md
           - Curseforge sample: samples/curseforge.md
           - Android: samples/android.md
           - DBus: samples/dbus-ratbagd.md