Merge pull request #10 from sparkfun/main

Move main to the develop branch

Author: gigapod

.github/workflows/build-iotnode-lorawan-develop.yml

@@ -1,11 +1,14 @@
 name: IoT Node - LoRaWAN -  Firmware build Action
 on:
   push:
-    branches:
-      - main
 
   workflow_dispatch:
     branches:
+      - 'main'
+      - 'develop'
+      - 'feature/**'
+      - 'release/**'
+      - 'hotfix/**'
 
 env:
   ARDUINO_RP2040_DIR: .arduino15/packages/rp2040/hardware/rp2040/4.3.1
@@ -20,8 +23,6 @@ jobs:
     steps:
       - name: Checkout Repo and submodules
         uses: actions/checkout@v3
-        with:
-          ref: main
 
       # checkout flux-sdk
       - name: Checkout the flux-sdk

.github/workflows/build-iotnode-lorawan-release1.0.0.yml

@@ -0,0 +1,37 @@
+name: Run mkdocs
+on:
+  push:
+    branches:
+      - main
+
+  workflow_dispatch:
+    branches:
+    
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python runtime
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install Python dependencies
+        run: pip install mkdocs-monorepo-plugin mkdocs-redirects mkdocs-with-pdf weasyprint mkdocs-git-authors-plugin mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2
+
+      - name: Set up build cache
+        uses: actions/cache@v2
+        with:
+          key: ${{ github.ref }}
+          path: .cache
+
+      - name: Install Insiders build
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: pip install git+https://${GH_TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git
+      - run: mkdocs gh-deploy --force

.github/workflows/build-iotnode-lorawan.yml

@@ -1,8 +1,41 @@
-# sfe-iot-node-lorawan
-IoT Node Firmware for a Dig LoRaWAN deployment
 
-### Compile command
+![SparkFun IoT Node - LoRaWAN Firmware](https://github.com/sparkfun/sfe-iot-node-lorawan/blob/main/docs/assets/img/IoT-Node-LoRaWAN-Banner.jpg "SparkFun IoT Node - LoRaWAN")
 
-```
-arduino-cli compile --fqbn rp2040:rp2040:sparkfun_promicrorp2350 --export-binaries ./sfeIoTNodeLoRaWAN/sfeIoTNodeLoRaWAN.ino --library `pwd`/SparkFun_Flux
-```
+# SparkFun IoT Node - LoRaWAN
+
+Firmware and associated Documentation and Firmware for the SparkFun IoT Node - LoRaWAN product
+
+![Release](https://img.shields.io/github/v/release/sparkfun/sfe-iot-node-lorawan)
+![Release Date](https://img.shields.io/github/release-date/sparkfun/sfe-iot-node-lorawan?display_date=published_at)
+![Documentation - build](https://img.shields.io/github/actions/workflow/status/sparkfun/sfe-iot-node-lorawan/pages%2Fpages-build-deployment?label=Documentation)
+[![IoT Node - LoRaWAN - build](https://github.com/sparkfun/sfe-iot-node-lorawan/actions/workflows/build-iotnode-lorawan-develop.yml/badge.svg)](https://github.com/sparkfun/sfe-iot-node-lorawan/actions/workflows/build-iotnode-lorawan-develop.yml)
+![GitHub issues](https://img.shields.io/github/issues/sparkfun/sfe-iot-node-lorawan)
+
+This repository contains the latest firmware for the SparkFun IoT Node - LoRaWAN development board. While the IoT Node - LoRaWAN development board is programmable using Arduino, the IoT Node - LoRa board ships with a firmware application that enables rapid sensor definition and deployment on a Digi LoRaWAN XON network. This repository contains the source for this LoRaWAN application and well as firmware releases.
+
+The IoT Node - LoRaWAN firmware is pre-programmed to automatically log data from 25+ SparkFun [Qwiic](https://www.sparkfun.com/qwiic) sensors, all without requiring any hardware setup or code development. Just plug in a qwiic board, and log data to the LoRaWAN network. The IoT Node - LoRaWAN board automatically detects the connected sensor, configures the device and enables logging to the serial console and, if connected, to the Digi LoRaWAN network.
+
+The SparkFun IoT Node - LoRaWAN board and firmware are designed to enable posting data to the LoRaWAN network within minutes, requiring no development or configuration. The SparkFun IoT Node - LoRaWAN board is configured to work with the Dig LoRaWAN network. Once the board is registered with your Digi XON account (via the on-board digital data tag - which is similar to a QR code), the board with this firmware should automatically connect to your Digi LoRaWAN account. Connect a supported qwiic sensor and data is automatically posted to the LoRaWAN network.
+
+The IoT Node - LoRaWAN firmware is highly configurable via an easily to use serial interface. Simply plug in a USB C cable and open a terminal at 115200 Kbps. By default the logging output is automatically streamed to the serial terminal - pressing any key will bring up the menu system. 
+
+Details are outlined in [IoT Node - LoRaWAN Documentation](https://docs.sparkfun.com/sfe-iot-node-lorawan).
+
+
+## Latest Firmware
+
+* Version 01.00.00 - [Release](https://github.com/sparkfun/sfe-iot-node-lorawan/releases/tag/v01.00.00)
+
+## Documentation
+
+* **[Hardware Hookup Guide](https://docs.sparkfun.com/SparkFun_IoT_Node_LoRaWAN/quick_start/)** - Basic hookup guide for the SparkFun IoT Node - LoRaWAN board
+* **GitHub Hardware Repo**
+  * **[SparkFun IoT Node - LoRaWAN](https://github.com/sparkfun/SparkFun_IoT_Node_LoRaWAN)**
+  
+## Supported Products
+
+* **[DEV-26060](https://www.sparkfun.com/products/26060)** - SparkFun IoT Node - LoRaWAN
+
+### Latest Release
+
+Details on the latest Firmware release are listed on the [Release Page](https://github.com/sparkfun/sfe-iot-node-lorawan/releases)