chore: Add readme file

selengalp · Feb 6, 2023 · 28ad363 · 28ad363
1 parent ed23837
commit 28ad363
Showing 1 changed file with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# Repo for switching AP mode and client mode of wifi
+
+It is suitable for dhcpcd managed network on Raspbian.
+
+# Installation
+```
+sudo chmod +x ./install.sh
+sudo ./install.sh
+```
+
+# Usage
+To switch to AP mode:
+```
+sudo ./switch_ap_mode.sh
+```
+
+To switch to client mode:
+```
+sudo ./switch_client_mode.sh
+```
+
+# Uninstallation
+```
+sudo chmod +x ./uninstall.sh
+sudo ./uninstall.sh
+```