From d96323fd81751d3f3b680c46c20fbe68bdda7af4 Mon Sep 17 00:00:00 2001
From: samuelspagl <samuel@spagl-media.de>
Date: Wed, 6 Sep 2023 16:50:10 +0200
Subject: [PATCH] add README.md

---
 README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5ceb8aa
--- /dev/null
+++ b/README.md
@@ -0,0 +1,64 @@
+# HomeAssistant: Samsung Soundbar Integration
+
+> Yet another Samsung Soundbar Integration (YASSI)
+
+## Why YASSI
+
+The current Samsung Soundbar Integration by @PiotrMachowski / @thierryBourbon are already pretty cool.
+But I wanted it to appear as a device, and base the Foundation on the `pysmartthings` python package.
+
+Additionally, I wanted full control over the *Soundmode* and more. So I tried out a few things with the API,
+and found that also the **Subwoofer** as well as the **Equalizer** are controllable.
+
+I created a new wrapper around the `pysmartthings.DeviceEntity` specifically set up for a Soundbar, and this
+is the Result.
+
+I hope to integrate also controls for **surround speaker** as well as **Space-Fit Sound**, but as these features
+are not documented... ;) 
+
+## Features
+
+- Set-Up through HomeAssistant-UI
+- Theoretically it should be possible to have multiple Devices (not tested)
+
+- `media_player` Entity
+  - On / Off
+  - Volume
+  - Mute
+  - Input Source
+  - Sound Mode
+  - Media
+    - Play / Pause / Stop
+    - Artist
+    - Title
+    - Music Cover Art url (iTunes Api)
+- `switch` entity
+  - Night mode
+  - Bass mode
+  - Voice amplifier
+- `number` entity
+  - bass level
+  - *[to come] equalizer bands*
+- `select` entity
+  - *[to come] sound mode* (additional control in the "Device" tab)
+  - *[to come] equalizer preset*
+
+## How to install it:
+
+### HACS: 
+>  ⚠️ not done yet but planned (hopefully)
+
+### Adding this repository as custom repository
+
+Add this repository as custom repository in HACS and install it ;)
+
+### Manual
+
+You can also copy the `samsung_soundbar` folder in the `custom_components` folder to
+your `config/custom_components` folder.
+
+
+## General Thanks
+
+Like already mentioned, thanks to @PiotrMachowski / @thierryBourbon for the general
+idea on how to do things.
\ No newline at end of file