Skip to content

Commit

Permalink
chore: Update Arduino Library Manager and PlatformIO installation ins…
Browse files Browse the repository at this point in the history
…tructions
  • Loading branch information
RobertByrnes committed Jul 14, 2024
1 parent 027c958 commit 26d8be4
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 7 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/pio_exaxmples.yml
Original file line number Diff line number Diff line change
@@ -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 }}
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 26d8be4

Please sign in to comment.