From 7fedbcdd520faeaf7d63941e5a06ae84bfa67d7a Mon Sep 17 00:00:00 2001
From: Giovanni Bruno <g.bruno@arduino.cc>
Date: Tue, 12 Mar 2024 19:18:16 +0100
Subject: [PATCH] updated readme

---
 README.md | 22 +++++++++++++++++++++-
 1 file changed, 21 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ee99531..e543293 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,24 @@
 # Arduino_AlvikCarrier
 
 
-W.I.P.
+This library is used to build the firmware required for Arduino® Alvik Carrier.
+
+To use the library, [stm32duino](https://github.com/stm32duino/Arduino_Core_STM32) is required.
+
+<br>
+<br>
+
+## Build parameters
+```
+Board: Generic STM32F4
+Board part number: Generic F411RCTx
+```
+
+To flash the firmware use the Arduino® Alvik documentation.
+
+<br>
+<br>
+
+## Useful links
+- [Product page](https://store.arduino.cc/pages/alvik)
+- [Micropython](https://github.com/arduino/arduino-alvik-mpy)
\ No newline at end of file