diff --git a/README.md b/README.md index c19697f..82e60bc 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,29 @@ -# Simple Tracking Plugin Installation +Simple Glitchtip Plugin Installation +Installation -## Installation +To install or update the Simple Glitchtip plugin, run the following command from the root of your WordPress HTML directory: -To install or update the Simple Tracking plugin, run the following command from the root of your WordPress HTML directory: +sh -```sh -curl -sSL https://git.nixc.us/colin/SimpleTracking/raw/branch/main/install.sh | bash -``` +curl -sSL https://git.nixc.us/colin/simple-glitchtip/raw/branch/main/install.sh | bash -## Enabling the Plugin +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 Tracking` in the list and click `Activate`. + Log in to your WordPress admin dashboard. + Navigate to Plugins > Installed Plugins. + Find Simple Glitchtip in the list and click Activate. -Alternatively, you can activate the plugin using WP-CLI: +What install.sh Does -```sh -wp plugin activate simple-tracking --allow-root -``` +The install.sh script performs the following actions: -## What `install.sh` Does + Defines the URL for downloading the simple-glitchtip.php file. + Creates the target directory (wp-content/plugins/simple-glitchtip) if it doesn't exist. + Downloads the simple-glitchtip.php file into the target directory. + Downloads the Sentry SDK as sentry.phar into the target directory. + Sets the correct permissions for the simple-glitchtip.php and sentry.phar files. + Prints a message indicating that the Simple Glitchtip plugin has been installed or updated successfully. -The `install.sh` script performs the following actions: - -1. Defines the URL for downloading the `simple-tracking.php` file. -2. Creates the target directory (`wp-content/plugins/simple-tracking`) if it doesn't exist. -3. Downloads the `simple-tracking.php` file into the target directory. -4. Creates a blank `tracking-code.php` file if it doesn't already exist and instructs the user to add their tracking code to it. -5. Sets the correct permissions for the `simple-tracking.php` and `tracking-code.php` files. -6. Prints a message indicating that the Simple Tracking plugin has been installed or updated successfully. +This setup includes the necessary error reporting functionality within a single plugin file and automates the installation and updating process via the provided install.sh script. \ No newline at end of file