Build Action (#1)

added build.yml for compiling the PlatformIO project.

.github/workflows/build.yml

@@ -0,0 +1,37 @@
+name: Compile Project
+
+# The workflow will run on every push and pull request to the repository
+on:
+  workflow_dispatch:
+  # (optional) Run workflow when pushing on master/main
+  push:
+  pull_request:
+    branches: ["main"]
+  schedule:
+    - cron:  '0 0 1 * *'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/pip
+            ~/.platformio/.cache
+          key: ${{ runner.os }}-pio
+      - uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+      - name: Install PlatformIO Core
+        run: pip install --upgrade platformio
+
+      - name: Build PlatformIO Project
+        run: pio run
+      - name: Archive ESP32 Firmware
+        uses: actions/upload-artifact@v4
+        with:
+          name: esp32-divoom
+          path: .pio/build/esp32dev/firmware.bin

README.md

@@ -1,2 +1,16 @@
 # esp32-divoom
-Divoom Proxy for ESP32
+[![Compile Project](https://github.com/d03n3rfr1tz3/esp32-divoom/actions/workflows/build.yml/badge.svg)](https://github.com/d03n3rfr1tz3/esp32-divoom/actions/workflows/build.yml)
+[![GitHub release](https://img.shields.io/github/release/d03n3rfr1tz3/esp32-divoom.svg)](https://github.com/d03n3rfr1tz3/esp32-divoom/releases/latest)
+
+**Divoom Proxy for ESP32**
+
+Allows you to send commands to your Divoom device through various protocols. It works as a companion for my [Home Assistant integration](https://github.com/d03n3rfr1tz3/hass-divoom),
+but you can also use it as standalone communicator for your Divoom devices. Currently the following input protocols are either implemented or planned. You can find more information
+in the documentation below.
+
+* **Serial**
+* **TCP**
+* MQTT (ToDo)
+
+## Documentation
+TODO