From 69cbcdafe09f6b3ae3dc0391073d499346324027 Mon Sep 17 00:00:00 2001
From: Alexey Khit <alexey.khit@gmail.com>
Date: Thu, 24 Aug 2023 20:50:15 +0300
Subject: [PATCH] Update readme about new features

---
 README.md | 23 +++++++++++++++++------
 1 file changed, 17 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index e62ec32..7aeed09 100644
--- a/README.md
+++ b/README.md
@@ -81,7 +81,7 @@ Component **doesn't create devices and entities**. It creates only two services
 
 ## Custom card
 
-As a `url` you can use any protocol supported in go2rtc or specify the stream name from the go2rtc config.  
+As a `url` you can use any protocol supported in go2rtc or **specify the stream name** from the go2rtc config.  
 As a `entity` you can use almost any camera from Hass.
 
 **Minimal**
@@ -93,6 +93,13 @@ url: 'rtsp://rtsp:12345678@192.168.1.123:554/av_stream/ch0'
 
 **or**
 
+```yaml
+type: 'custom:webrtc-camera'
+url: 'camera1'  # stream name from go2rtc.yaml
+```
+
+**or**
+
 ```yaml
 type: 'custom:webrtc-camera'
 entity: camera.generic_stream  # change to your camera entity_id
@@ -104,22 +111,28 @@ entity: camera.generic_stream  # change to your camera entity_id
 type: 'custom:webrtc-camera'
 streams:
   - url: go2rtc_stream_hd
-    name: HD
+    name: HD     # name is optional
     mode: webrtc # mode is optional
   - url: go2rtc_stream_sd
     name: SD
-    mode: mse 
+    mode: mse
 ```
 
 **Full**
 
+**All settings are optional!** Only required setting - `url` or `entity` or `streams`.
+
 ```yaml
 type: 'custom:webrtc-camera'
+
 url: 'rtsp://rtsp:12345678@192.168.1.123:554/av_stream/ch0'
+entity: camera.generic_stream
+mode: webrtc,webrtc/tcp,mse,hls,mjpeg  # stream technology, default all of them
+server: http://192.168.1.123:1984/     # custom go2rtc server address, default empty
 
 ui: true  # custom video controls, default false
 
-digital_ptz:  # digital zoom and pan via mouse/touch. Defaults to:
+digital_ptz:  # digital zoom and pan via mouse/touch, defaults:
   mouse_drag_pan: true 
   mouse_wheel_zoom: true
   mouse_double_click_zoom: true
@@ -143,8 +156,6 @@ shortcuts:  # custom shortcuts, default none
   service: switch.toggle
   service_data:
     entity_id: switch.camera_record
-
-mode: webrtc,mse,hls,mjpeg  # also available - webrtc/tcp
 ```
 
 Pan, tilt, zoom controls: [PTZ config examples](https://github.com/AlexxIT/WebRTC/wiki/PTZ-Config-Examples).