updated readme

Author: gbr1

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)