Update documentation and examples

Author: baldram

README.md

@@ -22,8 +22,9 @@ To use this library in your PlatformIO project, simply add to your `platformio.i
 
 ```
 lib_deps =
-    baldram/ESP_VS1053_Library
+    ESP_VS1053_Library
 ```
+or `lib_deps = 1744` .
 
 From your `.cpp` or `.ino` code include VS1053 library.
 
@@ -75,23 +76,19 @@ Log.notice("Hello, this is a debug message!");
 
 An example for ESP8266 based board like eg. LoLin NodeMCU V3 or WeMos D1 R2.
 
-```
-
-  ---------------------
-  | VS1053  | ESP8266 |
-  ---------------------
-  |   SCK   |   D5    |
-  |   MISO  |   D6    |
-  |   MOSI  |   D7    |
-  |   XRST  |   RST   |
-  |   CS    |   D1    |
-  |   DCS   |   D0    |
-  |   DREQ  |   D3    |
-  |   5V    |   VU    |
-  |   GND   |   G     |
-  ---------------------
-  
-```
+|  VS1053  | ESP8266  |
+|----------|----------|
+| SCK      | D5       |
+| MISO     | D6       |
+| MOSI     | D7       |
+| XRST     | RST      |
+| CS       | D1       |
+| DCS      | D0       |
+| DREQ     | D3       |
+| 5V       | VU       |
+| GND      | G        |
+
+For ESP32 and other boards wiring examples please see thread [Supported hardware](https://github.com/baldram/ESP_VS1053_Library/issues/1) and [Tested boards](https://github.com/baldram/ESP_VS1053_Library/blob/master/doc/SimpleMp3Player/tested-boards.md) list.
 
 <img alt="VS1053B and NodeMCU v3" title="VS1053B and NodeMCU v3" src="https://user-images.githubusercontent.com/16861531/27875071-3ead1674-61b2-11e7-9a69-02edafa7b286.jpg" width="300px" />
 

doc/tested-boards.md

@@ -0,0 +1,21 @@
+#### ESP_VS1053_Library tested and compatible boards
+
+---
+
+Known working targets:
+
+* ESP8266 based **LoLin NodeMCU V3** (ESP-12F) with **LC Technology VS1053** MP3 Codec board<br />
+([click here](https://github.com/baldram/ESP_VS1053_Library/issues/1#issuecomment-313163772) for additional information and photos),
+* ESP8266 based **RobotDyn WiFi D1 R2** (ESP-8266 EX) with **LC Technology VS1053** MP3 Codec board<br />
+([click here](https://github.com/baldram/ESP_VS1053_Library/issues/1#issuecomment-313163772) for additional information and photos)
+* ESP32 based board **Espressif ESP32 DevKitC** / ESP32 Core Board V2 (ESP-WROOM-32) with **LC Technology VS1053** MP3 Codec board<br />
+([click here](https://github.com/baldram/ESP_VS1053_Library/issues/1#issuecomment-313907348) for additional information and photos)
+* ...
+
+No information:
+
+* everything else!
+
+**Please report any known working combinations** so I can update this!<br />
+An issue to test working targets was [created here](https://github.com/baldram/ESP_VS1053_Library/issues/1), so it's possible to simply leave a comment.<br />
+A **pull request** to update this file is also **very welcome**!

examples/SimpleMp3Player/SimpleMp3Player.cpp

@@ -21,7 +21,9 @@
   |   GND   |   G     |
   ---------------------
 
-  Note: It's just an example, you may use a different pins definition
+  Note: It's just an example, you may use a different pins definition.
+  For ESP32 example, please follow the link:
+    https://github.com/baldram/ESP_VS1053_Library/issues/1#issuecomment-313907348
 
   To run this example define the platformio.ini as below.
 
@@ -31,12 +33,17 @@
   framework = arduino
 
   lib_deps =
-    baldram/ESP_VS1053_Library
+    ESP_VS1053_Library
 
 */
 
 #include <Arduino.h>
-#include <VS1053.h> // this ESP_VS1053_Library
+
+// This ESP_VS1053_Library
+#include <VS1053.h>
+
+// Please find helloMp3.h file here:
+//      https://github.com/baldram/ESP_VS1053_Library/blob/master/examples/SimpleMp3Player/helloMp3.h
 #include <helloMp3.h>
 
 // Wiring of VS1053 board (SPI connected in a standard way)

examples/SimpleMp3PlayerWithDebug/SimpleMp3PlayerWithDebug.cpp

@@ -25,7 +25,9 @@
   |   GND   |   G     |
   ---------------------
 
-  Note: It's just an example, you may use a different pins definition
+  Note: It's just an example, you may use a different pins definition.
+  For ESP32 example, please follow the link:
+    https://github.com/baldram/ESP_VS1053_Library/issues/1#issuecomment-313907348
 
   To run this example define the platformio.ini as below.
 
@@ -35,13 +37,20 @@
   framework = arduino
 
   lib_deps =
-    baldram/ESP_VS1053_Library
+    ESP_VS1053_Library
 
 */
 
 #include <Arduino.h>
-#include <ArduinoLog.h> // PlatformIO library id=1532
-#include <VS1053.h> // this ESP_VS1053_Library
+
+// ArduinoLog.h is PlatformIO library id=1532
+#include <ArduinoLog.h>
+
+// This ESP_VS1053_Library
+#include <VS1053.h>
+
+// Please find helloMp3.h file here:
+//      https://github.com/baldram/ESP_VS1053_Library/blob/master/examples/SimpleMp3Player/helloMp3.h
 #include <helloMp3.h>
 
 // Wiring of VS1053 board (SPI connected in a standard way)