From c66e1d84a43f2a531cd7c96c9298770f257b9a12 Mon Sep 17 00:00:00 2001 From: per1234 Date: Mon, 11 Oct 2021 22:02:02 -0700 Subject: [PATCH] Add readme This provides a quick overview of the project. --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9501c14 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +# arduinoOTA + +[![Check General Formatting status](https://github.com/arduino/arduinoOTA/actions/workflows/check-general-formatting-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-general-formatting-task.yml) +[![Check Prettier Formatting status](https://github.com/arduino/arduinoOTA/actions/workflows/check-prettier-formatting-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-prettier-formatting-task.yml) +[![Spell Check status](https://github.com/arduino/arduinoOTA/actions/workflows/spell-check-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/spell-check-task.yml) +[![Check Markdown status](https://github.com/arduino/arduinoOTA/actions/workflows/check-markdown-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-markdown-task.yml) +[![Check Shell Scripts status](https://github.com/arduino/arduinoOTA/actions/workflows/check-shell-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-shell-task.yml) +[![Check Taskfiles status](https://github.com/arduino/arduinoOTA/actions/workflows/check-taskfiles.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-taskfiles.yml) +[![Check Workflows status](https://github.com/arduino/arduinoOTA/actions/workflows/check-workflows-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-workflows-task.yml) +[![Check YAML status](https://github.com/arduino/arduinoOTA/actions/workflows/check-yaml-task.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-yaml-task.yml) +[![Check License status](https://github.com/arduino/arduinoOTA/actions/workflows/check-license.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/check-license.yml) +[![Sync Labels status](https://github.com/arduino/arduinoOTA/actions/workflows/sync-labels.yml/badge.svg)](https://github.com/arduino/arduinoOTA/actions/workflows/sync-labels.yml) + +**arduinoOTA** is a tool for uploading programs to [Arduino](https://arduino.cc/) boards over a network. + +## Usage + +Run the following command for documentation of the command line interface: + +``` +arduinoOTA --help +``` + +## Security + +If you think you found a vulnerability or other security-related bug in this project, please read our +[security policy](https://github.com/arduino/arduino-lint/security/policy) and report the bug to our Security Team 🛡️ +Thank you! + +e-mail contact: security@arduino.cc