From c991eb9c004ce2af8028471e036a99b7ec4f617b Mon Sep 17 00:00:00 2001 From: kattudden <75677047+kattudden@users.noreply.github.com> Date: Tue, 7 Jan 2025 16:24:59 +0100 Subject: [PATCH] Update Readme. --- README.md | 33 +++++++++++++++------------------ 1 file changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 0b00cad..11cd20e 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,30 @@ # swayidle-ctrl -This Go application allows you to manage a swayidle process for screen and display timeout on Sway desktops. +This Go application allows you to enable or disable the swayidle service. +It would also be possible to do it directly with systemctl... ## Features -- Starts a swayidle process in the background with configurable timeouts. -- Terminates any existing swayidle process before starting a new one. -- Provides a flag to disable screen and display timeout functionalities. +- stop / start the swayidle service. ## Usage This application can be run from the command line. Here's how: -``` -swayidle-ctrl -t1 -t2 [-off] +```txt +swayidle-ctrl [-on|-off] Arguments: - -t1 (default: 300): Sets the timeout in seconds for screen lock activation. - -t2 (default: 600): Sets the timeout in seconds for display power off. + -on (default: false): Enables screen lock and display timeout functionalities. -off (default: false): Disables screen lock and display timeout functionalities. ``` -### Example: +### Examples -Start swayidle with 5 minutes screen lock timeout and 10 minutes display power off timeout: +Enable screen lock and display timeout: ``` bash -swayidle-ctrl -t1 300 -t2 600 +swayidle-ctrl -on ``` Disable screen lock and display timeout: @@ -45,13 +43,12 @@ swayidle-ctrl -off ### Additional Notes -* This application uses `sh -c` to execute the swayidle command. You might need to adjust this based on your specific setup. -* The application terminates any existing `swayidle` process before starting a new one. This ensures you don't have multiple instances running concurrently. -* Consider adding support for additional swayidle functionalities or configuration options in future versions. - +- This application uses `sh -c` to execute the swayidle command. You might need to adjust this based on your specific setup. +- The application terminates any existing `swayidle` process before starting a new one. This ensures you don't have multiple instances running concurrently. +- Consider adding support for additional swayidle functionalities or configuration options in future versions. This readme provides a basic overview of the application. You can customize it further by adding information about: -* Contributing guidelines -* License information -* Troubleshooting tips \ No newline at end of file +- Contributing guidelines +- License information +- Troubleshooting tips