From 29d72afa9fb7cfa951c055257076d4022d2b91fe Mon Sep 17 00:00:00 2001
From: "google-labs-jules[bot]"
<161369871+google-labs-jules[bot]@users.noreply.github.com>
Date: Fri, 2 Jan 2026 19:59:37 +0000
Subject: [PATCH 1/3] Update README.md with comprehensive project documentation
- Replaced the auto-generated README.md with a detailed manual one.
- Added sections for Project Overview, Tech Stack, and Project Structure.
- Documented the development workflow using Lando and Grunt.
- Verified installation steps and feature usage against the codebase.
- Clarified the distinction between production usage and local development.
---
README.md | 159 +++++++++++++++++++++++++++++++++---------------------
1 file changed, 97 insertions(+), 62 deletions(-)
diff --git a/README.md b/README.md
index e46a3a5..5373d2a 100644
--- a/README.md
+++ b/README.md
@@ -1,86 +1,121 @@
-# Shortcode Widget #
-[](https://travis-ci.com/gagan0123/shortcode-widget) [](https://gitlab.com/gagan0123/shortcode-widget/commits/master) [](https://gitlab.com/gagan0123/shortcode-widget/commits/master)
-
+# Shortcode Widget
+A WordPress plugin that provides a "Shortcode Widget", allowing users to execute shortcodes within a widget area. This plugin bridges the gap in the default text widget by enabling shortcode execution and offering optional paragraph formatting.
-**Contributors:** [gagan0123](https://profiles.wordpress.org/gagan0123)
-**Donate Link:** https://PayPal.me/gagan0123
-**Tags:** Shortcode, Widget
-**Requires at least:** 3.3
-**Requires PHP:** 5.6
-**Tested up to:** 5.6
-**Stable tag:** 1.5.3
-**License:** GPLv2 or later
-**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
+**Version**: 1.5.3
+**License**: GPLv2 or later
+**Tags**: Shortcode, Widget
-Adds a text-like widget that allows you to write shortcode in it.
+## Project Overview
-## Description ##
+The **Shortcode Widget** plugin registers a new widget in WordPress that accepts arbitrary text and shortcodes. Unlike the standard text widget (in older WP versions), this widget processes shortcodes (`do_shortcode`) before rendering. It also provides an option to automatically add paragraphs (`wpautop`), similar to the visual editor.
-Adds a text-like widget that allows you to write shortcode in it. (Just whats missing in the default text widget)
-To test the widget you can add the widget and use the shortcode "[shortcode_widget_test]", it will display "It works" on the frontend and this will confirm the widget does work.
+This repository contains the source code for the plugin, including unit tests and build scripts.
-## Installation ##
+## Tech Stack
-1. Add the plugin's folder in the WordPress' plugin directory.
-1. Activate the plugin.
-1. You are now ready to use the Shortcode Widget from the Widgets section.
-1. To test the widget you can add the widget and use the shortcode "[shortcode_widget_test]", it will display "It works" on the frontend and this will confirm the widget does work.
+- **Language**: PHP (Plugin logic)
+- **CMS**: WordPress (Tested with WP 5.6+, supports PHP 8.2 via Lando)
+- **Development Environment**: Lando (Docker-based)
+- **Testing**: PHPUnit
+- **Build Tools**: Node.js, Grunt (for generating `README.md` from `readme.txt` and POT files)
-## Screenshots ##
-### 1. Shortcode Widget that can be found in Widgets section ###
-
+## Project Structure
-### 2. Adding the widget to the sidebar ###
-
+```
+.
+├── assets/ # Icons and screenshots for the WP directory
+├── includes/ # Core logic
+│ ├── class-shortcode-widget-plugin.php # Plugin singleton, hooks setup
+│ └── class-shortcode-widget.php # The Widget class (WP_Widget)
+├── languages/ # Translation files (.pot)
+├── tests/ # PHPUnit tests
+├── .lando.yml # Lando configuration for local dev
+├── Gruntfile.js # Grunt tasks (readme conversion, i18n)
+├── package.json # Node dependencies
+├── phpunit.xml.dist # PHPUnit configuration
+├── readme.txt # WordPress.org plugin repository readme
+└── shortcode-widget.php # Main plugin entry point
+```
-### 3. Widget with the output of the shortcode ###
-
+## Installation & Setup
+### For Users (Production)
-## Changelog ##
+1. Upload the `shortcode-widget` folder to the `/wp-content/plugins/` directory.
+2. Activate the plugin through the 'Plugins' menu in WordPress.
+3. Go to **Appearance > Widgets**.
+4. Drag the **Shortcode Widget** to a sidebar.
-### 1.5.3 ###
-* Strict PHPCS ruleset adherence.
-* More documentation in widget class.
-* Testing with WordPress 5.6
+### For Developers (Local Setup)
-### 1.5.2 ###
-* Some PHPCS corrections, making code adhering to WordPress coding standards.
-* Replaced strip_tags function with wp_strip_all_tags.
+This project uses [Lando](https://lando.dev/) for a consistent local development environment.
-### 1.5.1 ###
-* Unescaped title back in the code as escaping it was creating issues with other plugins.
+**Prerequisites:**
+- Docker
+- Lando
-### 1.5 ###
-* Added icon and screenshots.
-* Escaping some values that could have been overridden by the translations.
-* Added pot file for translations.
-* Change in calling of widget_text filter with new parameter that was added in WordPress 4.4.1
+**Steps:**
-### 1.4 ###
-* Updated compatibility with WordPress 4.8
-* Reversed the order of changelog.
+1. Clone the repository:
+ ```bash
+ git clone https://github.com/gagan0123/shortcode-widget.git
+ cd shortcode-widget
+ ```
-### 1.3 ###
-* Minor bug fix.
-* Changed tested up to version number.
-* Made it translation ready, constant was being used for text domains, silly error, I know :)
+2. Start the environment:
+ ```bash
+ lando start
+ ```
+ This will:
+ - Spin up a PHP 8.2 / Apache / MySQL environment.
+ - Install WordPress.
+ - Install the `twentytwentyone` theme.
+ - Link the plugin to the WordPress installation.
-### 1.2 ###
-* Corrections in text domain and added one more string as translatable.
+3. Access the site:
+ Lando will provide a URL (e.g., `https://shortcode-widget.lndo.site/`).
-### 1.1 ###
-* Reflecting the changes that have been done to the default text widget over the years.
+**Environment Variables:**
+The code itself relies on standard WordPress constants (e.g., `ABSPATH`). The local environment uses standard Lando variables (see `.lando.yml`).
-### 1.0 ###
-* Tested with WP 4.0
+## Features & Usage
-### 0.3 ###
-* Added a shortcode for testing the plugin '[shortcode_widget_test]'
+### Key Features
+- **Shortcode Execution**: parses any shortcodes entered in the content area.
+- **Content Filtering**: Option to "Automatically add paragraphs" (applies `wpautop`).
+- **Unfiltered HTML**: Supports raw HTML if the user has `unfiltered_html` capability.
+- **Test Shortcode**: Includes a built-in shortcode `[shortcode_widget_test]` which outputs "It works" for verification.
-### 0.2 ###
-* Added translation support.
+### Usage
+1. Add the **Shortcode Widget** to a widget area.
+2. **Title**: Enter a title for the widget (optional).
+3. **Content**: Enter text, HTML, or shortcodes (e.g., `[gallery]`, `[contact-form-7]`, or `[shortcode_widget_test]`).
+4. **Automatically add paragraphs**: Check this box to convert double line breaks to HTML paragraphs.
-### 0.1 ###
-* Added the shortcode widget.
\ No newline at end of file
+## Development Workflow
+
+### Running Tests
+Unit tests are written using PHPUnit and the WordPress Test Suite.
+
+To run tests inside Lando:
+```bash
+# Verify the test setup (usually handled by Lando recipe or needs manual bootstrap)
+# Assuming standard PHPUnit execution:
+lando phpunit
+```
+
+### Build Tasks
+Grunt is used for maintenance tasks.
+
+1. Install dependencies:
+ ```bash
+ lando npm install
+ ```
+
+2. Run default tasks (Updates `README.md` from `readme.txt` and generates `.pot` file):
+ ```bash
+ lando grunt
+ ```
+
+*Note: The `README.md` in the root is technically a build artifact generated from `readme.txt`. However, for GitHub viewers, this document serves as the primary source of truth for the codebase structure and development.*
From 0fa2c5491dbdd400621d026ed9a3a39788ec9a2e Mon Sep 17 00:00:00 2001
From: "google-labs-jules[bot]"
<161369871+google-labs-jules[bot]@users.noreply.github.com>
Date: Fri, 2 Jan 2026 20:32:37 +0000
Subject: [PATCH 2/3] Update README.md with comprehensive project documentation
and preserved metadata
- Replaced the auto-generated README.md with a detailed manual one.
- Restored original plugin metadata, badges, and changelog.
- Added sections for Project Overview, Tech Stack, and Project Structure.
- Documented the development workflow using Lando and Grunt.
- Verified installation steps and feature usage against the codebase.
- Clarified the distinction between production usage and local development.
---
README.md | 109 +++++++++++++++++++++++++++++++++++-------------------
1 file changed, 71 insertions(+), 38 deletions(-)
diff --git a/README.md b/README.md
index 5373d2a..73df337 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,18 @@
-# Shortcode Widget
-
-A WordPress plugin that provides a "Shortcode Widget", allowing users to execute shortcodes within a widget area. This plugin bridges the gap in the default text widget by enabling shortcode execution and offering optional paragraph formatting.
-
-**Version**: 1.5.3
-**License**: GPLv2 or later
-**Tags**: Shortcode, Widget
+# Shortcode Widget #
+[](https://travis-ci.com/gagan0123/shortcode-widget) [](https://gitlab.com/gagan0123/shortcode-widget/commits/master) [](https://gitlab.com/gagan0123/shortcode-widget/commits/master)
+
+
+**Contributors:** [gagan0123](https://profiles.wordpress.org/gagan0123)
+**Donate Link:** https://PayPal.me/gagan0123
+**Tags:** Shortcode, Widget
+**Requires at least:** 3.3
+**Requires PHP:** 5.6
+**Tested up to:** 5.6
+**Stable tag:** 1.5.3
+**License:** GPLv2 or later
+**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
+
+Adds a text-like widget that allows you to write shortcode in it.
## Project Overview
@@ -40,14 +48,13 @@ This repository contains the source code for the plugin, including unit tests an
## Installation & Setup
-### For Users (Production)
-
-1. Upload the `shortcode-widget` folder to the `/wp-content/plugins/` directory.
-2. Activate the plugin through the 'Plugins' menu in WordPress.
-3. Go to **Appearance > Widgets**.
-4. Drag the **Shortcode Widget** to a sidebar.
+### Standard Installation
+1. Add the plugin's folder in the WordPress' plugin directory.
+1. Activate the plugin.
+1. You are now ready to use the Shortcode Widget from the Widgets section.
+1. To test the widget you can add the widget and use the shortcode "[shortcode_widget_test]", it will display "It works" on the frontend and this will confirm the widget does work.
-### For Developers (Local Setup)
+### Developer Setup (Lando)
This project uses [Lando](https://lando.dev/) for a consistent local development environment.
@@ -76,12 +83,8 @@ This project uses [Lando](https://lando.dev/) for a consistent local development
3. Access the site:
Lando will provide a URL (e.g., `https://shortcode-widget.lndo.site/`).
-**Environment Variables:**
-The code itself relies on standard WordPress constants (e.g., `ABSPATH`). The local environment uses standard Lando variables (see `.lando.yml`).
-
## Features & Usage
-### Key Features
- **Shortcode Execution**: parses any shortcodes entered in the content area.
- **Content Filtering**: Option to "Automatically add paragraphs" (applies `wpautop`).
- **Unfiltered HTML**: Supports raw HTML if the user has `unfiltered_html` capability.
@@ -93,29 +96,59 @@ The code itself relies on standard WordPress constants (e.g., `ABSPATH`). The lo
3. **Content**: Enter text, HTML, or shortcodes (e.g., `[gallery]`, `[contact-form-7]`, or `[shortcode_widget_test]`).
4. **Automatically add paragraphs**: Check this box to convert double line breaks to HTML paragraphs.
-## Development Workflow
+## Screenshots
+### 1. Shortcode Widget that can be found in Widgets section
+
-### Running Tests
-Unit tests are written using PHPUnit and the WordPress Test Suite.
+### 2. Adding the widget to the sidebar
+
-To run tests inside Lando:
-```bash
-# Verify the test setup (usually handled by Lando recipe or needs manual bootstrap)
-# Assuming standard PHPUnit execution:
-lando phpunit
-```
+### 3. Widget with the output of the shortcode
+
-### Build Tasks
-Grunt is used for maintenance tasks.
+## Changelog
-1. Install dependencies:
- ```bash
- lando npm install
- ```
+### 1.5.3
+* Strict PHPCS ruleset adherence.
+* More documentation in widget class.
+* Testing with WordPress 5.6
-2. Run default tasks (Updates `README.md` from `readme.txt` and generates `.pot` file):
- ```bash
- lando grunt
- ```
+### 1.5.2
+* Some PHPCS corrections, making code adhering to WordPress coding standards.
+* Replaced strip_tags function with wp_strip_all_tags.
+
+### 1.5.1
+* Unescaped title back in the code as escaping it was creating issues with other plugins.
+
+### 1.5
+* Added icon and screenshots.
+* Escaping some values that could have been overridden by the translations.
+* Added pot file for translations.
+* Change in calling of widget_text filter with new parameter that was added in WordPress 4.4.1
+
+### 1.4
+* Updated compatibility with WordPress 4.8
+* Reversed the order of changelog.
+
+### 1.3
+* Minor bug fix.
+* Changed tested up to version number.
+* Made it translation ready, constant was being used for text domains, silly error, I know :)
+
+### 1.2
+* Corrections in text domain and added one more string as translatable.
+
+### 1.1
+* Reflecting the changes that have been done to the default text widget over the years.
+
+### 1.0
+* Tested with WP 4.0
+
+### 0.3
+* Added a shortcode for testing the plugin '[shortcode_widget_test]'
+
+### 0.2
+* Added translation support.
-*Note: The `README.md` in the root is technically a build artifact generated from `readme.txt`. However, for GitHub viewers, this document serves as the primary source of truth for the codebase structure and development.*
+### 0.1
+* Added the shortcode widget.
From 17f536a62155267069b0f1f9708c4efd9407358e Mon Sep 17 00:00:00 2001
From: "google-labs-jules[bot]"
<161369871+google-labs-jules[bot]@users.noreply.github.com>
Date: Fri, 2 Jan 2026 20:40:22 +0000
Subject: [PATCH 3/3] Update readme.txt and regenerate README.md
- Updated `readme.txt` with comprehensive technical documentation (Tech Stack, Project Structure, Developer Setup).
- Preserved all original plugin metadata, badges, and the full changelog.
- Ran `grunt` to regenerate `README.md` from `readme.txt`, ensuring both files are in sync and technically accurate.
- Verified that the new `README.md` reflects the changes correctly.
---
README.md | 80 +++++++++++++++++++++++----------------------
package-lock.json | 1 +
readme.txt | 82 ++++++++++++++++++++++++++++++++++++++++++++---
3 files changed, 120 insertions(+), 43 deletions(-)
diff --git a/README.md b/README.md
index 73df337..e979311 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,8 @@
[](https://travis-ci.com/gagan0123/shortcode-widget) [](https://gitlab.com/gagan0123/shortcode-widget/commits/master) [](https://gitlab.com/gagan0123/shortcode-widget/commits/master)
-**Contributors:** [gagan0123](https://profiles.wordpress.org/gagan0123)
+
+**Contributors:** [gagan0123](https://profiles.wordpress.org/gagan0123/)
**Donate Link:** https://PayPal.me/gagan0123
**Tags:** Shortcode, Widget
**Requires at least:** 3.3
@@ -12,23 +13,23 @@
**License:** GPLv2 or later
**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
-Adds a text-like widget that allows you to write shortcode in it.
+A WordPress plugin that provides a "Shortcode Widget", allowing users to execute shortcodes within a widget area.
-## Project Overview
+## Project Overview ##
The **Shortcode Widget** plugin registers a new widget in WordPress that accepts arbitrary text and shortcodes. Unlike the standard text widget (in older WP versions), this widget processes shortcodes (`do_shortcode`) before rendering. It also provides an option to automatically add paragraphs (`wpautop`), similar to the visual editor.
This repository contains the source code for the plugin, including unit tests and build scripts.
-## Tech Stack
+## Tech Stack ##
-- **Language**: PHP (Plugin logic)
-- **CMS**: WordPress (Tested with WP 5.6+, supports PHP 8.2 via Lando)
-- **Development Environment**: Lando (Docker-based)
-- **Testing**: PHPUnit
-- **Build Tools**: Node.js, Grunt (for generating `README.md` from `readme.txt` and POT files)
+* **Language**: PHP (Plugin logic)
+* **CMS**: WordPress (Tested with WP 5.6+, supports PHP 8.2 via Lando)
+* **Development Environment**: Lando (Docker-based)
+* **Testing**: PHPUnit
+* **Build Tools**: Node.js, Grunt (for generating `README.md` from `readme.txt` and POT files)
-## Project Structure
+## Project Structure ##
```
.
@@ -46,21 +47,22 @@ This repository contains the source code for the plugin, including unit tests an
└── shortcode-widget.php # Main plugin entry point
```
-## Installation & Setup
+## Installation ##
+
+### Standard Installation ###
-### Standard Installation
1. Add the plugin's folder in the WordPress' plugin directory.
1. Activate the plugin.
1. You are now ready to use the Shortcode Widget from the Widgets section.
1. To test the widget you can add the widget and use the shortcode "[shortcode_widget_test]", it will display "It works" on the frontend and this will confirm the widget does work.
-### Developer Setup (Lando)
+### Developer Setup (Lando) ###
This project uses [Lando](https://lando.dev/) for a consistent local development environment.
**Prerequisites:**
-- Docker
-- Lando
+* Docker
+* Lando
**Steps:**
@@ -83,72 +85,74 @@ This project uses [Lando](https://lando.dev/) for a consistent local development
3. Access the site:
Lando will provide a URL (e.g., `https://shortcode-widget.lndo.site/`).
-## Features & Usage
+## Features & Usage ##
-- **Shortcode Execution**: parses any shortcodes entered in the content area.
-- **Content Filtering**: Option to "Automatically add paragraphs" (applies `wpautop`).
-- **Unfiltered HTML**: Supports raw HTML if the user has `unfiltered_html` capability.
-- **Test Shortcode**: Includes a built-in shortcode `[shortcode_widget_test]` which outputs "It works" for verification.
+* **Shortcode Execution**: parses any shortcodes entered in the content area.
+* **Content Filtering**: Option to "Automatically add paragraphs" (applies `wpautop`).
+* **Unfiltered HTML**: Supports raw HTML if the user has `unfiltered_html` capability.
+* **Test Shortcode**: Includes a built-in shortcode `[shortcode_widget_test]` which outputs "It works" for verification.
+
+### Usage ###
-### Usage
1. Add the **Shortcode Widget** to a widget area.
2. **Title**: Enter a title for the widget (optional).
3. **Content**: Enter text, HTML, or shortcodes (e.g., `[gallery]`, `[contact-form-7]`, or `[shortcode_widget_test]`).
4. **Automatically add paragraphs**: Check this box to convert double line breaks to HTML paragraphs.
-## Screenshots
-### 1. Shortcode Widget that can be found in Widgets section
+## Screenshots ##
+### 1. Shortcode Widget that can be found in Widgets section ###
-### 2. Adding the widget to the sidebar
+### 2. Adding the widget to the sidebar ###
-### 3. Widget with the output of the shortcode
+### 3. Widget with the output of the shortcode ###
-## Changelog
-### 1.5.3
+## Changelog ##
+
+### 1.5.3 ###
* Strict PHPCS ruleset adherence.
* More documentation in widget class.
* Testing with WordPress 5.6
-### 1.5.2
+### 1.5.2 ###
* Some PHPCS corrections, making code adhering to WordPress coding standards.
* Replaced strip_tags function with wp_strip_all_tags.
-### 1.5.1
+### 1.5.1 ###
* Unescaped title back in the code as escaping it was creating issues with other plugins.
-### 1.5
+### 1.5 ###
* Added icon and screenshots.
* Escaping some values that could have been overridden by the translations.
* Added pot file for translations.
* Change in calling of widget_text filter with new parameter that was added in WordPress 4.4.1
-### 1.4
+### 1.4 ###
* Updated compatibility with WordPress 4.8
* Reversed the order of changelog.
-### 1.3
+### 1.3 ###
* Minor bug fix.
* Changed tested up to version number.
* Made it translation ready, constant was being used for text domains, silly error, I know :)
-### 1.2
+### 1.2 ###
* Corrections in text domain and added one more string as translatable.
-### 1.1
+### 1.1 ###
* Reflecting the changes that have been done to the default text widget over the years.
-### 1.0
+### 1.0 ###
* Tested with WP 4.0
-### 0.3
+### 0.3 ###
* Added a shortcode for testing the plugin '[shortcode_widget_test]'
-### 0.2
+### 0.2 ###
* Added translation support.
-### 0.1
+### 0.1 ###
* Added the shortcode widget.
diff --git a/package-lock.json b/package-lock.json
index 41ad97d..f938da2 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -436,6 +436,7 @@
"integrity": "sha512-/ABUy3gYWu5iBmrUSRBP97JLpQUm0GgVveDCp6t3yRNIoltIYw7rEj3g5y1o2PGPR2vfTRGa7WC/LZHLTXnEzA==",
"dev": true,
"license": "MIT",
+ "peer": true,
"dependencies": {
"dateformat": "~4.6.2",
"eventemitter2": "~0.4.13",
diff --git a/readme.txt b/readme.txt
index df6ce6c..446a714 100644
--- a/readme.txt
+++ b/readme.txt
@@ -9,20 +9,92 @@ Stable tag: 1.5.3
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
-Adds a text-like widget that allows you to write shortcode in it.
+A WordPress plugin that provides a "Shortcode Widget", allowing users to execute shortcodes within a widget area.
-== Description ==
+== Project Overview ==
-Adds a text-like widget that allows you to write shortcode in it. (Just whats missing in the default text widget)
-To test the widget you can add the widget and use the shortcode "[shortcode_widget_test]", it will display "It works" on the frontend and this will confirm the widget does work.
+The **Shortcode Widget** plugin registers a new widget in WordPress that accepts arbitrary text and shortcodes. Unlike the standard text widget (in older WP versions), this widget processes shortcodes (`do_shortcode`) before rendering. It also provides an option to automatically add paragraphs (`wpautop`), similar to the visual editor.
+
+This repository contains the source code for the plugin, including unit tests and build scripts.
+
+== Tech Stack ==
+
+* **Language**: PHP (Plugin logic)
+* **CMS**: WordPress (Tested with WP 5.6+, supports PHP 8.2 via Lando)
+* **Development Environment**: Lando (Docker-based)
+* **Testing**: PHPUnit
+* **Build Tools**: Node.js, Grunt (for generating `README.md` from `readme.txt` and POT files)
+
+== Project Structure ==
+
+```
+.
+├── assets/ # Icons and screenshots for the WP directory
+├── includes/ # Core logic
+│ ├── class-shortcode-widget-plugin.php # Plugin singleton, hooks setup
+│ └── class-shortcode-widget.php # The Widget class (WP_Widget)
+├── languages/ # Translation files (.pot)
+├── tests/ # PHPUnit tests
+├── .lando.yml # Lando configuration for local dev
+├── Gruntfile.js # Grunt tasks (readme conversion, i18n)
+├── package.json # Node dependencies
+├── phpunit.xml.dist # PHPUnit configuration
+├── readme.txt # WordPress.org plugin repository readme
+└── shortcode-widget.php # Main plugin entry point
+```
== Installation ==
+= Standard Installation =
+
1. Add the plugin's folder in the WordPress' plugin directory.
1. Activate the plugin.
1. You are now ready to use the Shortcode Widget from the Widgets section.
1. To test the widget you can add the widget and use the shortcode "[shortcode_widget_test]", it will display "It works" on the frontend and this will confirm the widget does work.
+= Developer Setup (Lando) =
+
+This project uses [Lando](https://lando.dev/) for a consistent local development environment.
+
+**Prerequisites:**
+* Docker
+* Lando
+
+**Steps:**
+
+1. Clone the repository:
+ ```bash
+ git clone https://github.com/gagan0123/shortcode-widget.git
+ cd shortcode-widget
+ ```
+
+2. Start the environment:
+ ```bash
+ lando start
+ ```
+ This will:
+ - Spin up a PHP 8.2 / Apache / MySQL environment.
+ - Install WordPress.
+ - Install the `twentytwentyone` theme.
+ - Link the plugin to the WordPress installation.
+
+3. Access the site:
+ Lando will provide a URL (e.g., `https://shortcode-widget.lndo.site/`).
+
+== Features & Usage ==
+
+* **Shortcode Execution**: parses any shortcodes entered in the content area.
+* **Content Filtering**: Option to "Automatically add paragraphs" (applies `wpautop`).
+* **Unfiltered HTML**: Supports raw HTML if the user has `unfiltered_html` capability.
+* **Test Shortcode**: Includes a built-in shortcode `[shortcode_widget_test]` which outputs "It works" for verification.
+
+= Usage =
+
+1. Add the **Shortcode Widget** to a widget area.
+2. **Title**: Enter a title for the widget (optional).
+3. **Content**: Enter text, HTML, or shortcodes (e.g., `[gallery]`, `[contact-form-7]`, or `[shortcode_widget_test]`).
+4. **Automatically add paragraphs**: Check this box to convert double line breaks to HTML paragraphs.
+
== Screenshots ==
1. Shortcode Widget that can be found in Widgets section
2. Adding the widget to the sidebar
@@ -73,4 +145,4 @@ To test the widget you can add the widget and use the shortcode "[shortcode_widg
* Added translation support.
= 0.1 =
-* Added the shortcode widget.
\ No newline at end of file
+* Added the shortcode widget.