Add README

README.md

@@ -0,0 +1,32 @@
+Stream server for ESPHome
+=========================
+
+Custom component for ESPHome to expose a UART stream over WiFi or Ethernet. Can be used as a serial-to-wifi bridge as
+known from ESPLink or ser2net by using ESPHome.
+
+This component creates a TCP server listening on port 6638 (by default), and relays all data between the connected
+clients and the serial port. It doesn't support any control sequences, telnet options or RFC 2217, just raw data.
+
+Usage
+-----
+
+Requires ESPHome v1.18.0 or higher.
+
+```yaml
+external_components:
+  - source: github://oxan/esphome-stream-server
+
+stream_server:
+```
+
+You can set the UART ID and port to be used under the `stream_server` component.
+
+```yaml
+uart:
+   id: uart_bus
+   # add further configuration for the UART here
+
+stream_server:
+   uart_id: uart_bus
+   port: 1234
+```

module.yaml

@@ -1,14 +0,0 @@
-esphome:
-  # ...
-  includes:
-    - stream_server.h
-    - stream_server.cpp
-
-uart:
-  id: uart_bus
-  #  ...
-  
-custom_component:
-  - lambda: |-
-      auto stream_server = new StreamServerComponent(id(uart_bus));
-      return {stream_server};