From 63f0410c3b01c087d82f61b467590f93b6862894 Mon Sep 17 00:00:00 2001
From: thek4n <thek4n@yandex.ru>
Date: Sun, 7 Jun 2026 21:30:47 +0300
Subject: [PATCH] docs: add license and beautify docs

---
 LICENSE   | 20 ++++++++++++++++
 README.md | 72 ++++++++++++++++++++++++++++++++++++++-----------------
 2 files changed, 70 insertions(+), 22 deletions(-)
 create mode 100644 LICENSE

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..2c7b860
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,20 @@
+Pump controller
+Copyright © 2026 thek4n <thek4n@yandex.ru>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
+OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
index 5647583..4699433 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,63 @@
-# Pump controller ESP32
-Контроллер насоса с веб интерфейсом.
+# 🚀 Pump Controller ESP32
+## Web-Controlled Smart Pump System
 
-
-<div style="display: flex; gap: 10px;">
+<div align="center">
   <img src="./.gitassets/index.jpg" alt="Main page" width="300">
   <img src="./.gitassets/setup.jpg" alt="Setup page" width="300">
+  <br>
+  <sub>⚙️ Main Dashboard &nbsp;&nbsp;|&nbsp;&nbsp; 🛠️ Setup Wizard</sub>
 </div>
 
+---
 
-## Сборка и прошивка
-```sh
+
+## ✨ Features
+- 📡 Web-based pressure monitoring
+- 🔧 OTA-ready & configurable via browser
+- 💡 LED status indicators
+- 🔁 Auto-reset & fail-safe AP mode
+- 🧠 Non-volatile memory for settings
+
+---
+
+
+## 🛠️ Build & Flash
+> 💡 *Requires ESP-IDF framework and `just` task runner*
+
+```bash
 PORT="/dev/ttyUSB0" \
 ESP_IDF="~/playground/esp-idf/"
 just build flash
 ```
 
-
-## Setup
-Настройка.
-
-При первом запуске устройства с прошивкой (!WIFI_AP) создастся wifi точка
-(default ssid: pumpcontroller). Подключиться и зайти в браузере на страницу
-192.168.4.1:80. Ввести пароль ssid и пароль основного wifi. Устройство
-перезагрузится и подключится к wifi и получит адрес (его можно узнать в
-настройках роутера). По этому адресу будет основная страница контроля давления.
-
-При вводе неверного пароля нужно осуществить сброс до заводских настроек и
-повторить настройку.
+---
 
 
-### Reset
-Сброс осуществляется замыканием пина D15 на землю и подключением питания.
-Устройство моргнет светодиодом 3 раза и перезагрузится, в этот момент нужно
-убрать замыкание D15 на землю.
+## 🌐First-Time Setup
+On **first boot**, the device creates a captive Wi-Fi access point:
+
+- **SSID:** `pumpcontroller`
+- **IP:** `192.168.4.1`
+- **Port:** `80`
+
+### Steps:
+1. Connect to `pumpcontroller` Wi-Fi
+2. Open browser → `http://192.168.4.1`
+3. Enter your **home Wi-Fi SSID + password**
+4. Device reboots → joins your network
+5. Find its IP in your router's DHCP list
+
+✅ That IP becomes your **pump control dashboard** 🎯
+
+> ⚠️ If you enter wrong credentials, the device will **not** connect.
+> You’ll need to **factory reset** and try again.
+
+---
+
+
+## 🔄 Factory Reset
+1. **Short pin `D15` to GND**
+2. **Power on** the device
+3. LED blinks **3 times** 🔴🔴🔴
+4. **Remove** the short after the 3rd blink
+5. Device reboots → access point mode restored