From 8ed45201724413c6ea3aa06df8f91b1cf78d2409 Mon Sep 17 00:00:00 2001
From: Ferdinand Schober <ferdinandschober20@gmail.com>
Date: Mon, 18 Mar 2024 09:54:38 +0100
Subject: [PATCH] Update README.md (#96)

* Update README.md

include release_bind in example config

* update config.toml as well
---
 README.md   | 7 +++++++
 config.toml | 3 +++
 2 files changed, 10 insertions(+)

diff --git a/README.md b/README.md
index 5ac8024..338859f 100644
--- a/README.md
+++ b/README.md
@@ -253,10 +253,17 @@ To automatically load clients on startup, the file `$XDG_CONFIG_HOME/lan-mouse/c
 To create this file you can copy the following example config:
 
 ### Example config
+> [!TIP]
+> key symbols in the release bind are named according
+> to their names in [src/scancode.rs#L172](src/scancode.rs#L172).
+> This is bound to change
 
 ```toml
 # example configuration
 
+# configure release bind
+release_bind = [ "KeyA", "KeyS", "KeyD", "KeyS" ]
+
 # optional port (defaults to 4242)
 port = 4242
 # # optional frontend -> defaults to gtk if available
diff --git a/config.toml b/config.toml
index 1ec4789..79f7719 100644
--- a/config.toml
+++ b/config.toml
@@ -1,5 +1,8 @@
 # example configuration
 
+# release bind
+release_bind = [ "KeyA", "KeyS", "KeyD", "KeyS" ]
+
 # optional port (defaults to 4242)
 port = 4242
 # optional frontend -> defaults to gtk if available