From 39565f5ae15270f7def6771d957aca4b636536ba Mon Sep 17 00:00:00 2001 From: colin Date: Sat, 29 Jun 2024 15:49:43 +0000 Subject: [PATCH] Update README.md --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6f1951a..31de1ec 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,33 @@ # Simple Status Plugin Installation +## Installation + To install or update the Simple Status plugin, run the following command from the root of your WordPress HTML directory: ```sh -curl -sSL https://yourdomain.com/path/to/install.sh | bash +curl -sSL https://git.nixc.us/colin/SimpleStatus/raw/branch/main/install.sh | bash +``` + +## Enabling the Plugin + +After running the install script, you need to activate the plugin. You can do this via the WordPress admin dashboard: + +1. Log in to your WordPress admin dashboard. +2. Navigate to `Plugins > Installed Plugins`. +3. Find `Simple Status` in the list and click `Activate`. + +Alternatively, you can activate the plugin using WP-CLI: + +```sh +wp plugin activate simple-status --allow-root +``` + +## What `install.sh` Does + +The `install.sh` script performs the following actions: + +1. Defines the URL for downloading the `simple-status.php` file. +2. Creates the target directory (`wp-content/plugins/simple-status`) if it doesn't exist. +3. Downloads the `simple-status.php` file into the target directory. +4. Sets the correct permissions for the `simple-status.php` file. +5. Prints a message indicating that the Simple Status plugin has been installed or updated successfully. \ No newline at end of file