wip:

README.md

@@ -1,5 +1,32 @@
-# esp_component_template
+# ESP32 ESP-IDF component for AC dimmer
 
+## Tested on
+
+1. [ESP32 ESP-IDF v5.5.1](https://docs.espressif.com/projects/esp-idf/en/v5.5.1/esp32/index.html)
+
+## Features
+
+1. Supports frequencies up to 400 Hz.
+2. Automatic frequency detection.
+
+## Using
+
+In an existing project, run the following command to install the components:
+
+```text
+cd ../your_project/components
+git clone http://git.zh.com.ru/esp_components/zh_ac_dimmer
+```
+
+In the application, add the component:
+
+```c
+#include "zh_ac_dimmer.h"
+```
+
+## Examples
+
+```c
 #include "zh_ac_dimmer.h"
 
 void app_main(void)
@@ -23,4 +50,5 @@ void app_main(void)
             vTaskDelay(100 / portTICK_PERIOD_MS);
         }
     }
-}
+}
+```

include/zh_ac_dimmer.h

@@ -60,11 +60,6 @@ extern "C"
      */
     esp_err_t zh_ac_dimmer_set(uint8_t value);
 
-    // /**
-    //  * @brief AC dimmer ISR handler.
-    //  */
-    // void zh_ac_dimmer_isr_handler(void);
-
 #ifdef __cplusplus
 }
 #endif