docs: update, install timeout

README.md

@@ -1,5 +1,7 @@
 # Helldivers 2 Mod Manager CLI
 
+Helldivers 2 Mod Manager CLI is a command line interface for managing Helldivers 2 mods. Since there is no Linux mod manager available and I like being a nerd by using CLI tools instead of GUIs, this project was born.
+
 - [Helldivers 2 Mod Manager CLI](#helldivers-2-mod-manager-cli)
   - [Installation](#installation)
   - [Usage](#usage)
@@ -9,6 +11,7 @@
       - [Uninstall a mod](#uninstall-a-mod)
       - [Enable/disable mods](#enabledisable-mods)
       - [List installed mods](#list-installed-mods)
+  - [Compatibility](#compatibility)
   - [Advanced usage](#advanced-usage)
     - [Shortcuts](#shortcuts)
     - [Exporting and importing](#exporting-and-importing)
@@ -17,8 +20,6 @@
   - [Contributing](#contributing)
   - [Planned features](#planned-features)
 
-Helldivers 2 Mod Manager CLI is a command line interface for managing Helldivers 2 mods. Since there is no mod manager GUI for Helldivers 2 on Linux yet, this small script aims to provide a simple way to manage mods on Linux.
-
 ## Installation
 
 To install/update Helldivers 2 Mod Manager CLI run the following command in your terminal:
@@ -44,8 +45,8 @@ h2mm
 - `list` - List all installed mods
 - `enable` - Enable a mod by name
 - `disable` - Disable a mod by name
-- `export <zip_name>` - Export installed mods to a zip file
+- `export` - Export installed mods to a zip file
-- `import <zip_name>` - Import mods from a zip file
+- `import` - Import mods from a zip file
 - `reset` - Reset all installed mods
 - `help` - Display the help message
 
@@ -69,7 +70,6 @@ h2mm uninstall "Example mod"
 h2mm uninstall -i 1 # uninstall mod with index 1
 ```
 
-
 #### Enable/disable mods
 
 ```bash
@@ -85,6 +85,16 @@ h2mm disable -i 1 # disable mod with index 1
 h2mm list
 ```
 
+## Compatibility
+
+The script is developed and tested on Arch Linux, but it should work on other Linux distributions as well. If you encounter any issues, please open an issue on the repository.
+
+Status of other platforms:
+
+- Linux :white_check_mark:
+- Steam Deck - Untested :grey_question:
+- WSL - Untested, should work :grey_question:
+
 ## Advanced usage
 
 ### Shortcuts

install.sh

@@ -61,8 +61,8 @@ if [[ -x "$(command -v $SCRIPT_NAME)" ]]; then
         # find hd2 path
         search_dir="${HOME}"
         target_dir="Steam/steamapps/common/Helldivers\ 2/data"
-        echo "Searching for the Helldivers 2 data directory..." >&2
+        echo "Searching for the Helldivers 2 data directory... (20 seconds timeout)" >&2
-        game_dir=$(find "$search_dir" -type d -path "*/$target_dir" 2>/dev/null | head -n 1)
+        game_dir=$(timeout 20 find "$search_dir" -type d -path "*/$target_dir" 2>/dev/null | head -n 1)
         if [[ -z "$game_dir" ]]; then
             echo "Could not find the Helldivers 2 data directory automatically." >&2
             read -p "Please enter the path to the Helldivers 2 data directory: " game_dir