Updated README

README.md

@@ -2,6 +2,15 @@
 
 This custom integration allows you to monitor and control your Unraid server from Home Assistant. Unraid is a popular NAS (Network Attached Storage) operating system that provides flexible storage, virtualization, and application support.
 
+## Development Status
+
+This integration is in active development. Here are a few things to keep in mind:
+
+- Features may be added, changed, or removed without notice.
+- There might be bugs or unexpected behavior.
+- Regular updates may be necessary as the integration evolves.
+- Feedback and contributions are welcome to help improve the integration.
+
 ## Features
 
 - Monitor CPU, RAM, Boot, Cache, Array Disks, and Array usage
@@ -13,6 +22,12 @@ This custom integration allows you to monitor and control your Unraid server fro
 
 ## Installation
 
+### HACS (Recommended)
+
+[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=domalab&repository=https%3A%2F%2Fgithub.com%2Fdomalab%2Fha-unraid&category=integration)
+
+### Manual
+
 1. Copy the `unraid` folder into your `custom_components` directory.
 2. Restart Home Assistant.
 3. Go to Configuration > Integrations.
@@ -52,4 +67,16 @@ Note: Setting lower intervals will provide more up-to-date information but may i
 - `unraid.execute_command`: Execute a shell command on the Unraid server
 - `unraid.execute_in_container`: Execute a command in a Docker container
 - `unraid.execute_user_script`: Execute a user script
-- `unraid.stop_user_script`: Stop a running user script
+- `unraid.stop_user_script`: Stop a running user script
+
+## Contributing
+
+Contributions to this integration are welcome. Please fork the repository and submit a pull request with your changes. Make sure to follow the contribution guidelines.
+
+## License
+
+This integration is released under the Apache License.
+
+## Disclaimer
+
+This integration is not officially associated with or endorsed by UNRAID. UNRAID trademarks belong to UNRAID, and this integration is independently developed.

info.md

@@ -1,6 +1,15 @@
 # Unraid Integration for Home Assistant
 
-This custom integration allows you to monitor and control your Unraid server from Home Assistant.
+This custom integration allows you to monitor and control your Unraid server from Home Assistant. Unraid is a popular NAS (Network Attached Storage) operating system that provides flexible storage, virtualization, and application support.
+
+## Development Status
+
+This integration is in active development. Here are a few things to keep in mind:
+
+- Features may be added, changed, or removed without notice.
+- There might be bugs or unexpected behavior.
+- Regular updates may be necessary as the integration evolves.
+- Feedback and contributions are welcome to help improve the integration.
 
 ## Features
 
@@ -13,6 +22,12 @@ This custom integration allows you to monitor and control your Unraid server fro
 
 ## Installation
 
+### HACS (Recommended)
+
+[![Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.](https://my.home-assistant.io/badges/hacs_repository.svg)](https://my.home-assistant.io/redirect/hacs_repository/?owner=domalab&repository=https%3A%2F%2Fgithub.com%2Fdomalab%2Fha-unraid&category=integration)
+
+### Manual
+
 1. Copy the `unraid` folder into your `custom_components` directory.
 2. Restart Home Assistant.
 3. Go to Configuration > Integrations.
@@ -28,16 +43,19 @@ During the setup, you'll need to provide:
 - Username: Your Unraid username (usually 'root')
 - Password: Your Unraid password
 - Port: SSH port (usually 22)
-- Ping Interval: How often to check if the server is online (in seconds)
-- Update Interval: How often to update sensor data (in seconds)
+- Ping Interval: How often to check if the server is online (in seconds). Default is 60 seconds.
+- Update Interval: How often to update sensor data (in seconds). Default is 300 seconds.
+
+Note: Setting lower intervals will provide more up-to-date information but may increase system load.
 
 ## Sensors
 
-- CPU Usage
-- RAM Usage
-- Array Usage
-- Individual Array Disks
-- Uptime
+- CPU Usage: Shows the current CPU utilization percentage.
+- RAM Usage: Displays the current RAM usage percentage.
+- Array Usage: Shows the overall array usage percentage.
+- Individual Array Disks: Displays usage information for each disk in the array.
+- Uptime: Shows how long the Unraid server has been running.
+- UPS Status: Displays information about the connected UPS (if available).
 
 ## Switches
 
@@ -51,12 +69,14 @@ During the setup, you'll need to provide:
 - `unraid.execute_user_script`: Execute a user script
 - `unraid.stop_user_script`: Stop a running user script
 
-## Examples
+## Contributing
+
+Contributions to this integration are welcome. Please fork the repository and submit a pull request with your changes. Make sure to follow the contribution guidelines.
+
+## License
+
+This integration is released under the Apache License.
 
-### Execute a shell command
+## Disclaimer
 
-```yaml
-service: unraid.execute_command
-data:
-  entry_id: YOUR_ENTRY_ID
-  command: "echo 'Hello from Home Assistant' > /boot/config/plugins/user.scripts/scripts/ha_test.sh"
+This integration is not officially associated with or endorsed by UNRAID. UNRAID trademarks belong to UNRAID, and this integration is independently developed.