updated README.md

Author: narethiya-godaddy

README.md

@@ -1,22 +1,25 @@
-# GoDaddy GitHub Action for Wordpress deployment
+# GoDaddy GitHub Action for Managed WordPress Deployment
 
 ## Overview
 
-This GitHub Action automates WordPress deployment using `rsync` over SSH. It creates a tar archive of modified files, transfers it to the remote server, and executes a deployment script. The action supports post-deployment commands, WordPress health checks, and automatic rollback in case of failures.
+This GitHub Action automates the deployment of your WordPress site by leveraging `rsync` over SSH. It packages only modified files into a tar archive, transfers them to your remote server, and executes a tailored deployment script. In addition, the action supports:
+- Post-deployment commands
+- WordPress health checks with automatic rollback upon failure
+- Secure authentication using an SSH private key
 
 ## Features
 
-- **Deploy only changed files** using `rsync --checksum`
-- **Remove deleted files** from the repository on the server
-- **Execute post-deployment commands**
-- **Perform WordPress health checks** and rollback if necessary
-- **Secure authentication** via SSH private key
+- **Deploy Only Changed Files:** Uses `rsync --checksum` to efficiently update only the modified files.
+- **Sync File Deletions:** Automatically removes files deleted from the repository on the server.
+- **Post-Deployment Commands:** Execute custom commands after deployment.
+- **WordPress Health Checks:** Monitor site health and trigger a rollback on failure.
+- **Secure SSH Authentication:** Ensures connectivity using your SSH private key.
 
 ## Usage
 
-### 1. **Add the Action to Your Workflow**
+### 1. Add the Action to Your Workflow
 
-Create a `.github/workflows/deploy.yml` file in your repository:
+Create a `.github/workflows/deploy.yml` file in your repository with the following content:
 
 ```yaml
 name: Deploy WordPress
@@ -25,25 +28,26 @@ on:
   workflow_dispatch:
     inputs:
       deployment_dest:
-        description: 'Target server directory, leave blank for root directory'
+        description: 'Target server directory; leave blank for the root directory'
         required: false
       enable_health_check:
-        description: 'Enable wordpress health check?'
+        description: 'Enable WordPress health check?'
         type: choice
         required: false
         default: "yes"
         options:
           - "yes"
           - "no"
+
 jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout repository
+      - name: Checkout Repository
         uses: actions/checkout@v3
 
-      - name: Deploy using GitHub Action
-        uses: your-org/your-action-repo@v1
+      - name: Deploy via GoDaddy GitHub Action
+        uses: godaddy-wordpress/[email protected]
         with:
           remote_host: ${{ secrets.REMOTE_HOST }}
           ssh_user: ${{ secrets.SSH_USER }}
@@ -52,44 +56,47 @@ jobs:
           enable_health_check: ${{ github.event.inputs.enable_health_check }}
 ```
 
-## Inputs
+### 2. Configuration Inputs
 
 | Name                    | Description                          | Required | Default |
-| ----------------------- | ------------------------------------ | -------- | ------- |
-| `remote_host`           | The remote server IP or domain       | ✅ Yes    | -       |
-| `ssh_user`              | SSH username for authentication      | ✅ Yes    | -       |
-| `ssh_private_key`       | SSH private key for authentication   | ✅ Yes    | -       |
-| `deployment_dest`       | Remote WordPress directory           | ❌ No     | `.`     |
-| `post_deploy_commands`  | Commands to run after deployment     | ❌ No     | `''`    |
-| `cleanup_deleted_files` | Remove deleted files from the server | ❌ No     | `yes`   |
-| `enable_health_check`   | Perform a WordPress health check     | ❌ No     | `yes`   |
-
-## Requirements
-
-- **Enable Git Deployment** for site from GoDaddy interface
-- **GitHub secrets configured** for `REMOTE_HOST`, `SSH_USER`, and `SSH_PRIVATE_KEY`
-
-## Troubleshooting
-
-### SSH Key Issues
-
-Ensure the private key format is correct and matches the server's authorized keys:
+| ----------------------- | ------------------------------------ | -------- | ------ |
+| `remote_host`           | The remote server IP or domain       | ✅ Yes    | -      |
+| `ssh_user`              | SSH username for authentication      | ✅ Yes    | -      |
+| `ssh_private_key`       | SSH private key for authentication   | ✅ Yes    | -      |
+| `deployment_dest`       | Remote WordPress directory           | ❌ No     | `''`     |
+| `cleanup_deleted_files` | Remove deleted files from the server | ❌ No     | `yes`  |
+| `enable_health_check`   | Perform a WordPress health check     | ❌ No     | `yes`  |
+
+
+### Requirements
+- Git Deployment Enabled: Activate Git Deployment for your site via the GoDaddy control panel.
+- GitHub Secrets: Ensure the following secrets are configured in your repository:
+    - `REMOTE_HOST`
+    - `SSH_USER`
+    - `SSH_PRIVATE_KEY`
+
+### Troubleshooting
+SSH Key Issues
+If you experience authentication problems, verify that your private key is correctly formatted and matches the public key configured on your server. You can use the following command to view your SSH key in a base64-encoded format:
 
 ```bash
 cat ~/.ssh/id_rsa | base64
 ```
+Copy the output and configure it as your repository's SSH_PRIVATE_KEY secret. (**Note:** You may have used a different name when creating your key. Please ammend the example to match your case.)
 
-Set the output as `SSH_PRIVATE_KEY` in GitHub Secrets.
-
-## License
+### For additional troubleshooting:
 
-This action is licensed under the MIT License.
+- Double-check your remote host details.
+- Ensure that the user has the proper permissions on the remote server.
+- Consult the issues tab in this repository for similar problems and their resolution.
 
-## Contributing
+### License
 
-Feel free to open issues or submit PRs for improvements!
+This GitHub Action is licensed under the MIT License.
 
-## Support
+### Contributing
 
-For help, open an issue in the repository.
+Contributions, bug reports, and ideas for improvements are welcome! Please open an issue or submit a pull request for discussion.
 
+## Support
+For additional help or support, please open an issue in this repository.