From ee71857a085cca8fd19699bddf910f1f218b0a33 Mon Sep 17 00:00:00 2001
From: Thomas Lekanger <thomas.lekanger@hotmail.com>
Date: Sat, 14 Dec 2024 20:16:11 +0100
Subject: [PATCH] chore: improve README

---
 README.md | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 987f973..1df5f58 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,16 @@ Features:
 
 This project is intended to be used with the latest Active LTS release of Node.js.
 
+## Documentation
+
+For usage examples, please check the [examples](/examples/) folder.
+Proper API documentation is coming at some point.
+
+## Known issues
+
+BLE (noble library) acts differently on each platform. I have not got this library fully stable yet.
+PRs are welcome.
+
 ## Available Scripts
 
 - `clean` - remove coverage data, Jest cache and transpiled files,