aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9e5946d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+
+# 🛰️ Orion RF (WIP)
+
+**Orion RF** is a portable RF & wireless experimentation toolkit built for the ESP32 platform.
+
+> ⚠️ This project is **work in progress** — many features are planned but not yet implemented.
+
+---
+
+## 🚀 Current Features
+
+* **BLE Scanning**
+
+ * Discover nearby Bluetooth Low Energy devices
+ * Display device info (MAC, RSSI, etc.)
+
+* **WiFi Scanning**
+
+ * Scan nearby access points
+ * View SSID, signal strength, channel, encryption
+
+* **WiFi Packet Analysis**
+
+ * Basic packet inspection and monitoring
+ * Useful for learning wireless traffic behavior
+
+* **BadUSB**
+
+ * HID-based payload execution
+ * Emulate keyboard input for automation/testing
+
+---
+
+## 🧩 Project Status
+
+| Feature | Status |
+| ----------------- | ---------- |
+| BLE Scan | ✅ Working |
+| WiFi Scan | ✅ Working |
+| Packet Analysis | ✅ Working |
+| BadUSB | ✅ Working |
+| SD Card | 🚧 WIP |
+| RF Capture/Replay | 🚧 WIP |
+| Emulator | 🚧 WIP |
+| NFC | 🚧 Planned |
+