Add documentationHEADmain

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..72a1129
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# wake-pulse
+
+Wake PulseAudio/PipeWire sinks from auto-suspend.
+
+## Installation
+
+```bash
+make install
+```
+
+## Usage
+
+```bash
+wake-pulse                    # Wake default sink, exit when awake
+wake-pulse -c                 # Keep default sink awake continuously
+wake-pulse -s sink_name       # Wake specific sink
+wake-pulse -s sink_name -c    # Keep specific sink awake continuously
+```
+
+## Options
+
+- `-s, --sink NAME` - Sink name to keep awake (default: system default sink)
+- `-c, --continuous` - Keep sink awake continuously (default: exit once awake)
+- `-h, --help` - Show help message
+
+## Dependencies
+
+- `bash`
+- `pulseaudio-utils` (pactl, paplay)
+
+## How It Works
+
+The script generates a silent WAV file and plays it on loop to prevent the audio sink from suspending. It monitors sink state changes via `pactl subscribe` and exits (or continues) based on the mode selected.
+
+## Uninstall
+
+```bash
+make uninstall
+```