From 4b15c37cfff6612d2b5d2e8cc15c0345fa9ac150 Mon Sep 17 00:00:00 2001
From: lathoub <4082369+lathoub@users.noreply.github.com>
Date: Sun, 8 Mar 2020 17:22:05 +0100
Subject: [PATCH] Update README.md

---
 README.md | 41 ++++++++++++++++++++++++++++++++++++-----
 1 file changed, 36 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 02839a6..1138a3f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,38 @@
-# Arduino-BLE-MIDI
-MIDI over Bluetooth Low Energy (BLE-MIDI) 2.0 for Arduino
+# Experimental
+   
+# Arduino BLE-MIDI Transport 
+This library implements the BLE-MIDI transport layer for the [FortySevenEffects Arduino MIDI Library](https://github.com/FortySevenEffects/arduino_midi_library) 
 
-Depends on [FortySevenEffects/MIDI](https://github.com/FortySevenEffects/arduino_midi_library) 
+## Installation
+This library depends on the [Arduino MIDI Library](https://github.com/FortySevenEffects/arduino_midi_library).
 
-# Supported devices
-Adafruit ESP32 Feather
+When installing this library from the Arduino IDE, the dependency be downloaded and installed in the same directory as this library. (Thanks to the `depends` clause in `library.properties`)
+
+When manually installing this library, you have to manually download [Arduino MIDI Library](https://github.com/FortySevenEffects/arduino_midi_library) from github and install it in the same directory as this library - without this additional install, this library will not be able to compile. 
+
+## Usage
+### Basic / Default
+```cpp
+#include <BLE-MIDI.h>
+#include <hardware/BLE-MIDI_ESP32.h>
+...
+BLEMIDI_CREATE_DEFAULT_ESP32_INSTANCE();
+...
+void setup()
+{
+   MIDI.begin(1);
+...
+void loop()
+{
+   MIDI.read();
+```
+will create a instance named `bleMIDI` and listens to incoming MIDI on channel 1.
+
+## Tested boards/modules
+- Adafruit Huzzah32 feather
+
+## Other Transport protocols:
+The libraries below  the same calling mechanism (API), making it easy to interchange the transport layer.
+- [Arduino AppleMIDI Transport](https://github.com/lathoub/Arduino-AppleMIDI-Library)
+- [Arduino USB-MIDI  Transport](https://github.com/lathoub/USB-MIDI)
+- [Arduino ipMIDI  Transport](https://github.com/lathoub/Arduino-ipMIDI)