Add initial README.md

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..945b725
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# BLE WB3S nebula galaxy projector
+
+The goal of this project is to create a firmware and possibly an app to control a cheap "YESLUSY LED Star Light" over BLE. This device ships with the WB3S chip (BK7231T) and unfortunately the tuya firmware.
+
+# Why?
+
+Because we can ^^
+
+I don't like the idea to connect to a cloud just to switch the lights of the galaxy. And I also don't like to use ESPHome or something similar for something which I want to control just locally.
+
+# Alternative
+
+There is a ESPHome version for these chips, if you want something which connects to your smart home this is a way better alternative.
+
+# Project status
+
+Currently, nothing to see :D
+
+# Contributions
+
+Are welcome, just create a PR :)
+
+# Acknowledging
+
+The BLE reverse engineering and the initial stack are taken from this blog post. 
+
+https//www.elektroda.com/rtvforum/topic3989434.html\#20742145
+
+The doc/notes.pdf is from the original authors with the following note:
+
+```
+Finally, while all the code by the author(s) is licensed under GPLv3, other code used in building the final project
+may be licensed under different terms and it is the responsibility of the reader to ensure compliance with
+the terms of each license before proceeding."
+```
\ No newline at end of file