Update library documentation

Signed-off-by: fpr <[email protected]>

Author: fpr

AUTHORS

@@ -31,8 +31,10 @@ Paul Stoffregen    https://github.com/PaulStoffregen
 per1234            https://github.com/per1234
 Richard Sim
 Scott Fitzgerald   https://github.com/shfitz
+STMicroelectronics https://github.com/stm32duino
 Thibaut Viard      https://github.com/aethaniel
 Tom Igoe           https://github.com/tigoe
+Wi6Labs            http://www.wi6labs.com/
 WizNet             http://www.wiznet.co.kr
 Zach Eveland       https://github.com/zeveland
 

README.adoc renamed to README

@@ -1,10 +1,3 @@
-= Ethernet Library for Arduino =
-
-With the Arduino Ethernet Shield, this library allows an Arduino board to connect to the internet.
-
-For more information about this library please visit us at
-http://www.arduino.cc/en/Reference/Ethernet
-
 == License ==
 
 Copyright (c) 2010 Arduino LLC. All right reserved.

README.md

@@ -1 +1,29 @@
-# STM32Ethernet
+# STM32Ethernet
+
+## Ethernet Library for Arduino
+
+With an STM32 board with Ethernet compatibility, this library allows a STM32
+board (NUCLEO, DISCOVERY, ...) to connect to the internet.  
+
+For more information about this library please visit us at
+http://www.arduino.cc/en/Reference/Ethernet
+
+## Note
+
+The library is based on LwIP, a Lightweight TCP/IP stack.  
+http://git.savannah.gnu.org/cgit/lwip.git
+The LwIP has been ported as Arduino library. The STM32Ethernet library depends
+on it.
+
+EthernetClass::maintain() in no more required to renew IP address from DHCP.  
+It is done automatically by the LwIP stack in a background task.  
+
+An Idle task is required by the LwIP stack to handle timer and data reception.
+This idle task is called inside the main loop in background by the function
+stm32_eth_scheduler(). Be careful to not lock the system inside the function
+loop() where LwIP could never be updated. Call EthernetUDP::parsePacket() or
+EthernetClient::available() performs an update of the LwIP stack.
+
+## Wiki
+
+You can find information at https://github.com/stm32duino/wiki/wiki/STM32Ethernet