From ab2755b879006d1ee1f4aa8e17926baf0a0f99a5 Mon Sep 17 00:00:00 2001 From: Ryan Malloy Date: Sat, 30 May 2026 15:02:42 -0600 Subject: [PATCH] docs(readme): Add Installation section with ZIP download and WP-CLI command Two clearly-labeled install methods at the top of the README so users know how to get the plugin without scrolling: - WordPress Admin GUI: 3-step ZIP upload - WP-CLI one-liner with --activate flag Both link directly to the v1.0.0 release ZIP on Gitea. --- README.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index aed10eb..253e2aa 100644 --- a/README.md +++ b/README.md @@ -60,30 +60,30 @@ Transform your WordPress site into a complete OAuth2 provider: --- -## ๐Ÿ“‹ Installation +## ๐Ÿ“ฆ Installation + +**Latest release:** [v1.0.0](https://git.supported.systems/tigerstyle/tigerstyle-scent/releases/tag/v1.0.0) ยท [All releases](https://git.supported.systems/tigerstyle/tigerstyle-scent/releases) ### Prerequisites -- WordPress 5.0 or higher -- PHP 7.4 or higher -- MySQL 5.7 or higher -- HTTPS enabled (recommended for production) +- WordPress 5.0+ +- PHP 7.4+ +- MySQL 5.7+ +- HTTPS strongly recommended (required for production OAuth2 flows) -### Quick Setup +### Via WordPress Admin (GUI) -1. **Clone the repository:** - ```bash - git clone https://github.com/tigerstyle/scent.git wp-content/plugins/tigerstyle-scent - ``` +1. Download [tigerstyle-scent-1.0.0.zip](https://git.supported.systems/tigerstyle/tigerstyle-scent/releases/download/v1.0.0/tigerstyle-scent-1.0.0.zip) +2. In WordPress admin: **Plugins โ†’ Add New โ†’ Upload Plugin**, pick the ZIP +3. Click **Activate Plugin** โ€” settings appear under **TigerStyle Scent** in the sidebar +4. Configure your territory: navigate to **TigerStyle Scent โ†’ Scent Profiles โ†’ Add New** -2. **Activate the plugin:** - - Go to WordPress Admin โ†’ Plugins - - Find "๐Ÿฏ TigerStyle Scent" - - Click "Activate" +### Via WP-CLI (terminal) -3. **Configure your territory:** - - Navigate to **TigerStyle Scent** in admin menu - - Set your territory preferences - - Create your first scent profile (OAuth2 client) +```bash +wp plugin install \ + https://git.supported.systems/tigerstyle/tigerstyle-scent/releases/download/v1.0.0/tigerstyle-scent-1.0.0.zip \ + --activate +``` ---