From 6f1a2eeb9187cf0c8e4260d2a0eb0306cc143a8f Mon Sep 17 00:00:00 2001
From: ColorfulRhino <131405023+ColorfulRhino@users.noreply.github.com>
Date: Sun, 30 Jun 2024 13:41:52 +0200
Subject: [PATCH] Add initial README contents

---
 README.md | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index f4822d7..7b73566 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,9 @@
-# wifi-rtl8852bs
-Vendor WiFi driver for Realtek RTL8852BS
+# RTL8852BS
+This is an out-of-tree driver for the Realtek RTL8852BS SDIO WiFi chipset.
+
+It has only been tested on Linux 6.1. If your kernel supports RTL8852BS in the RTW89 driver, please use RTW89 instead.
+
+The original sources for this repopsitory are cloned from [BianbuLinux/linux-6.1](https://gitee.com/bianbu-linux/linux-6.1/tree/bl-v1.0.y/drivers/net/wireless/realtek/rtl8852bs)
+and also includes commits from [vicharak-in/rockchip-linux-kernel](https://github.com/vicharak-in/rockchip-linux-kernel/tree/master/drivers/net/wireless/rockchip_wlan/rtl8852bs).
+
+These sources have not been verified or audited. Use at your own risk!