Skip to content

readme: add CI badges and examples list #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2025
Merged

readme: add CI badges and examples list #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
# Arduino Cloud Utils
# 🛠️ Arduino Cloud Utils

This library contains a set of functionalities that may be shared among cloud related projects, in particular functionalities for ArduinoIoTCloud
[![Arduino Lint](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/check-arduino.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/check-arduino.yml) [![Compile Examples](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/compile-examples.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/compile-examples.yml) [![Spell Check](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/spell-check.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/spell-check.yml) [![Sync Labels](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino-libraries/Arduino_CloudUtils/actions/workflows/sync-labels.yml)

This library contains a set of functionalities that may be shared among cloud related projects, in particular functionalities for ArduinoIoTCloud

# 🔧 Utilities
* ✉️ [CRC16](examples/crc16)
* 📧 [CRC32](examples/crc32)
* 🔒 [CBOR decoder](examples/customCborDecoder)
* 🔓 [CBOR encoder](examples/customCborEncoder)
* ⬆️ [LZSS decoder](examples/lzssDecoder)
* 💨 [SHA256](examples/sha256)
* ⏲️ [Timed action](examples/timedBlink)