Updated docs

Author: ruudboon

README.md

@@ -1,5 +1,45 @@
-# vmix-tally-nodemcu
-Tally for vMix using wifi. Creates an AP to configure the local wifi, vMix host and tally number. 
+# vMix Tally NodeMCU
+Tally for vMix using NodeMCU and 2 NeoPixel Mini PCB. 
 
-Inspired by
+## How It Works
+- When your ESP starts up, it sets it up in Station mode and tries to connect to a previously saved Access Point
+- if this is unsuccessful (or no previous network saved) it moves the ESP into Access Point mode and spins up a DNS and WebServer (default ip 192.168.4.1)
+- using any wifi enabled device with a browser (computer, phone, tablet) connect to the newly created Access Point (ESP*)
+- because of the Captive Portal and the DNS server you will either get a 'Join to network' type of popup or get any domain you try to access redirected to the configuration portal
+- choose the access points that connects your vMix, enter password, click save
+- start Configuration App (Currently MacOS only) and scan for Tally Nodes
+- configure your nodes with the vMix IP and tally number.
+
+## Needed Hardware
+- NodeMCU v3
+- 2 NeoPixels Mini PCB
+- Usb cable
+- USB powersupply or Powerbank
+- WiFi connection to your vMix computer
+
+## Flashing NodeMCU (V3)
+- Download latest release
+- Unpack zip
+- Open vmix-tally.ino with arduino IDE
+- Install the extra libraries (WiFiManager by tzapu 2.0.3-alpha, Adafruit NeoPixel by Adafruit 1.5.0)
+- Flash NodeMCU
+
+## NodeMCU pin layout
+- Connect 1 NeoPixel input to 1 NeoPixel output (+,signal,-)
+- Connect + of first NeoPixel to pin VU
+- Connect - of first NeoPixel to ground
+- Connect signal of first NeoPixel to D2
+- Power using USB
+
+## Current plans
+- Add 3d printer case design
+- Stabilize, optimise and improve software
+- Add windows & linux App
+- Improve documentation
+- Configure using webinterface
+- Ask vMix for ZeroConf broadcast to allow auto connect
+- Create demonstration video
+
+##Inspired by
 * [Arduino-vMix-tally](https://github.com/ThomasMout/Arduino-vMix-tally)
+* [WiFiManager](https://github.com/tzapu/WiFiManager)