From 26d8be4bfd7bd952331e87b353057b1c66577d44 Mon Sep 17 00:00:00 2001 From: RobertByrnes Date: Sun, 14 Jul 2024 20:29:14 +0100 Subject: [PATCH] chore: Update Arduino Library Manager and PlatformIO installation instructions --- .github/workflows/pio_exaxmples.yml | 43 +++++++++++++++++++++++++++++ README.md | 15 +++++----- 2 files changed, 51 insertions(+), 7 deletions(-) create mode 100644 .github/workflows/pio_exaxmples.yml diff --git a/.github/workflows/pio_exaxmples.yml b/.github/workflows/pio_exaxmples.yml new file mode 100644 index 0000000..e1f3037 --- /dev/null +++ b/.github/workflows/pio_exaxmples.yml @@ -0,0 +1,43 @@ +name: Build and Test PlatformIO Examples + +on: [push, pull_request] + +jobs: + build: + runs-on: ubuntu-latest + + strategy: + matrix: + board: + - esp32dev + - esp32doit-devkit-v1 + - esp32-wrover-kit + - esp-wrover-kit + example: + - Esp32-platformIO/t-call-esp32-sim800l-alpn-protos + - Esp32-platformIO/t-call-esp32-sim800l-aws + - Esp32-platformIO/t-call-esp32-sim800l-cert-bundle + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.8' + + - name: Install PlatformIO + run: | + python -m pip install --upgrade pip + pip install platformio + + - name: Initialise PlatformIO Project + run: | + pio project init --board ${{ matrix.board }} + working-directory: ./examples/${{ matrix.example }} + + - name: Build Example + run: | + pio run + working-directory: ./examples/${{ matrix.example }} diff --git a/README.md b/README.md index 9013fef..b75742b 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,6 @@ [![License](https://img.shields.io/badge/License-MIT-blue)](#license) [![issues - SSLClient](https://img.shields.io/github/issues/govorox/SSLClient)](https://github.com/govorox/SSLClient/issues) -[![PlatformIO Registry](https://badges.registry.platformio.org/packages/digitaldragon/library/SSLClient.svg)](https://registry.platformio.org/libraries/digitaldragon/SSLClient "Go to PlatformIO Registry") - -[![arduino-library-badge](https://img.shields.io/static/v1?label=Arduino%20Libraries&message=GovoroxSSLClient&color=orange&logo=arduino)](https://www.arduinolibraries.info/libraries/govorox-ssl-client "Go to Arduino Libraries") - ## 🚀 Overview SSLClient extends the ESP32/Arduino ecosystem to secure communication via TLS, providing a transparent SSL/TLS layer over any **Client** class instance. Leverages *mbedtls* for robust, efficient cryptographic operations, initially tailored for ESP32 but adaptable across platforms. @@ -44,10 +40,15 @@ Based on the [WiFiClientSecure](https://github.com/espressif/arduino-esp32/tree/ ## 🔧 Installation -Install via the Arduino Library Manager or PlatformIO: +Install via the Arduino Library Manager or PlatformIO plugin: + +[![arduino-library-badge](https://img.shields.io/static/v1?label=Arduino%20Libraries&message=GovoroxSSLClient&color=orange&logo=arduino)](https://www.arduinolibraries.info/libraries/govorox-ssl-client "Go to Arduino Libraries") + +**Arduino IDE** - search for "SSLClient" + +[![PlatformIO Registry](https://badges.registry.platformio.org/packages/digitaldragon/library/SSLClient.svg)](https://registry.platformio.org/libraries/digitaldragon/SSLClient "Go to PlatformIO Registry") -Arduino IDE: Search for "SSLClient". -PlatformIO: Add `digitaldragon/SSLClient@^1.3.0` to platformio.ini. +**VSCode / PlatformIO** - add `digitaldragon/SSLClient@^1.3.0` to `platformio.ini` ## 🛠 Usage