From b18b18ec99a65c4b0bbf7e847b83dc38bad1fd8f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Va=C5=A1ek=20Chalupn=C3=AD=C4=8Dek?=
 <vasekch@users.noreply.github.com>
Date: Wed, 5 May 2021 10:29:47 +0200
Subject: [PATCH] Create README.md

---
 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9f08e41
--- /dev/null
+++ b/README.md
@@ -0,0 +1,19 @@
+# blesync
+
+Motivation: Original MicroPython to handle BLE communication is IRQ with callback functions [ubluetooth docs](https://docs.micropython.org/en/latest/library/ubluetooth.html). This library is to wrap this with synchronuous approach.
+
+
+Comparison of scan devices procedure:
+
+original in **ubluetooth**:
+
+```
+BLE.irq(...) - register handler `_IRQ_SCAN_RESULT` (all handlers in one function)
+BLE.gap_scan(...) - returns nothing
+```
+
+our approach **blesync**:
+
+```
+blesync.scan(...) - returns iterator with the same structure as original uPy ubluetooth
+```